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

Format docstrings with docformatter #218

Merged
merged 3 commits into from
Jan 20, 2021
Merged

Format docstrings with docformatter #218

merged 3 commits into from
Jan 20, 2021

Conversation

jneeven
Copy link
Contributor

@jneeven jneeven commented Dec 18, 2020

Low priority, just to prevent future frustration. Doesn't need to be in 1.1.0.

AdamHillier
AdamHillier reviewed Jan 13, 2021
View reviewed changes
Copy link
Contributor

@AdamHillier AdamHillier left a comment

Choose a reason for hiding this comment

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

Idk if docformatter will accept these suggestions - the only gripe I have about it is that it tries to split two short sentences onto separate lines.

As an aside, could you add a lint action to check these formattings?

zookeeper/core/factory_registry.py Show resolved Hide resolved
zookeeper/core/utils.py Show resolved Hide resolved
zookeeper/tf/dataset.py Show resolved Hide resolved
zookeeper/tf/experiment.py Show resolved Hide resolved
@jneeven
Copy link
Contributor Author

jneeven commented Jan 20, 2021

Idk if docformatter will accept these suggestions - the only gripe I have about it is that it tries to split two short sentences onto separate lines.

Yeah agreed, unfortunately this isn't optional

@AdamHillier AdamHillier added documentation Issues related to documentation and removed internal-improvement labels Jan 20, 2021
@AdamHillier AdamHillier merged commit 69386ff into master Jan 20, 2021
@AdamHillier AdamHillier deleted the docformatting branch January 20, 2021 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AdamHillier AdamHillier AdamHillier approved these changes

Assignees
No one assigned
Labels
documentation Issues related to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@jneeven @AdamHillier