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.

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

Merge additional pydocstyle error fixes into development docs #1208

Merged
merged 51 commits into from Jul 28, 2021

Conversation

RNKuhns
Copy link
Contributor

@RNKuhns RNKuhns commented Jul 26, 2021

Reference Issues/PRs

This partially addresses docstring updates needed to eventually implement #890.

What does this implement/fix? Explain your changes.

Primarily includes docstring fixes to pass pydocstyle checks that were needed because changes had to be made to some docstrings for numpydoc parsing.

Also includes a couple tweaks to the look of the documentation pages.

  • Changes navigation bar titles from users to "user documentation" and developers to "get involved"
  • Makes updates to "getting started" page
  • Turns on autodoc member ordering by source to order documentation of members (eg. attributes, methods) by the order they show up in source code (not sure this is working)

Does your contribution introduce a new dependency? If yes, which one?

N/A. Just updates docstrings.

What should a reviewer concentrate their feedback on?

Any other comments?

PR checklist

For all contributions
  • I've added myself to the list of contributors.
  • Optionally, I've updated sktime's CODEOWNERS to receive notifications about future changes to these files.
  • I've added unit tests and made sure they pass locally.
For new estimators
  • I've added the estimator to the online documentation.
  • I've updated the existing example notebooks or provided a new one to showcase how my estimator works.

@RNKuhns
Copy link
Contributor Author

RNKuhns commented Jul 26, 2021

@mloning can you take a look at the changes in this and merge it into our development documentation branch if they look fine?

Almost exclusively updates to pass pydocstyle checks. Also included minor tweaks to performance metric documentation's .rst file.

@RNKuhns RNKuhns added documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution labels Jul 26, 2021
@aiwalter
Copy link
Contributor

great work @RNKuhns

@mloning
Copy link
Contributor

mloning commented Jul 26, 2021

Fixed the merge conflicts

Copy link
Contributor

@mloning mloning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work @RNKuhns - looks all good to me

autodoc_default_options = {
"members": True,
"inherited-members": True,
"member-order": "bysource",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is nice! so we should make sure fit, predict, transform and update are at the top in the code, right?

Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice and also fixes docstrings in different places

@mloning mloning merged commit 93b06e0 into sktime:docs-dev Jul 28, 2021
@mloning
Copy link
Contributor

mloning commented Jul 28, 2021

I've merged this now @RNKuhns - wanted to look at a few other things based on your changes!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants