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

Fix docstrings #204

Merged
merged 2 commits into from
Jan 13, 2021
Merged

Fix docstrings #204

merged 2 commits into from
Jan 13, 2021

Conversation

rouille
Copy link
Collaborator

@rouille rouille commented Jan 13, 2021 •
edited
Loading

Purpose

Fix docstrings that create warning when running Sphinx and move to empty __init__ files.

Where to look

  • In postreise/analyze/time.py: the =* was a problem for Sphinx. The = is replaced by is everywhere.
  • In postreise/plot/plot_renewable_capacity_map.py: there was an indentation issue that produced a warning.
  • I have removed the __all__ from the __init__ files since it is useless and we have better things to do than remember to keep it up to date.

Time estimate

5 min

@rouille rouille added the documentation Documentation related to package label Jan 13, 2021
@rouille rouille added this to the Serenity Now milestone Jan 13, 2021
BainanXia
BainanXia approved these changes Jan 13, 2021
View reviewed changes
Copy link
Collaborator

@BainanXia BainanXia left a comment

Choose a reason for hiding this comment

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

Looks good to me. Hopefully, empty __init__ files won't make my Github Desktop app unhappy as before.

@rouille
Copy link
Collaborator Author

rouille commented Jan 13, 2021

Looks good to me. Hopefully, empty __init__ files won't make my Github Desktop app unhappy as before.

Ah. I was not aware of that.

@rouille rouille merged commit 5d5d33c into develop Jan 13, 2021
@rouille rouille deleted the ben/sphinx branch January 13, 2021 21:48
@ahurli ahurli mentioned this pull request Mar 16, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jenhagg jenhagg jenhagg approved these changes

@BainanXia BainanXia BainanXia approved these changes

@danielolsen danielolsen Awaiting requested review from danielolsen

Assignees

@danielolsen danielolsen

@rouille rouille

@BainanXia BainanXia

@jenhagg jenhagg

Labels
documentation Documentation related to package
Projects
None yet
Milestone
Serenity Now
Development

Successfully merging this pull request may close these issues.
4 participants
@rouille @BainanXia @jenhagg @danielolsen