-
Notifications
You must be signed in to change notification settings - Fork 118
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.
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
Docstrings standardization #586
Docstrings standardization #586
Conversation
@@ -0,0 +1,16 @@ | |||
# Model Selection | |||
|
|||
:::sklego.model_selection.GroupTimeSeriesSplit |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mkdocs/api/model-selection.md
Outdated
|
||
:::sklego.model_selection.GroupTimeSeriesSplit | ||
options: | ||
show_root_full_path: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job! I only found one page with issues here. That's a ton of work!
I left one comment about adding the import path. I don't know if it can be automated. But it might be nice to perhaps manually add on top?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn't find any more issues from eyeballing this ... so I think it's good to merge :)
Description
This PR aims to refactor all the modules docstring in order to standardize them into numpy style.
Therefore
numpydoc
dependency and extension has been added as well.Remark: The target building tool is mkdocs-materials instead of sphinx, therefore some part will not render properly when tested with sphinx. If the decision is to stick with sphinx, then more changes are necessary.
To check how those would render, I added a minimal (?) mkdocs.yaml which reads mkdocs/ folder containing just a page API rendering.
It can be tested by running the following command:
Additional information