Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Check versioned dataset/model builder docstrings in sphinx docs #8

Open
kostaleonard opened this issue Nov 26, 2021 · 0 comments
Open

Check versioned dataset/model builder docstrings in sphinx docs #8

kostaleonard opened this issue Nov 26, 2021 · 0 comments
Assignees
@kostaleonard
Labels
documentation Improvements or additions to documentation
Milestone
Second release

Comments

@kostaleonard
Copy link
Owner

The docstrings in versioned dataset/model builder classes have some formatting that may get mangled in auto doc generation. Check the generated docs to make sure that the documentation on those classes is readable.
@kostaleonard kostaleonard added the documentation Improvements or additions to documentation label Nov 26, 2021
@kostaleonard kostaleonard added this to the First release milestone Nov 26, 2021
@kostaleonard kostaleonard self-assigned this Nov 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kostaleonard kostaleonard

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Second release
Development

No branches or pull requests
1 participant
@kostaleonard