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

Improve code comments #31

Merged
merged 5 commits into from
Nov 20, 2019
Merged

Improve code comments #31

merged 5 commits into from
Nov 20, 2019

Conversation

anapaulagomes
Copy link
Contributor

This PR is an attempt of making the comments stick to a style. We're considering to adopt Google's docstrings but open to suggestions as usual.

  • Add pydocstyle as pre-commit hook
  • Get rid of single quote comments
  • Fix pydocstyle complains, except for the ones that would demand to add new comments:
D100: Missing docstring in public module
D103: Missing docstring in public function
D101: Missing docstring in public class
D107: Missing docstring in __init__
D102: Missing docstring in public method

@anapaulagomes anapaulagomes added the enhancement New feature or request label Oct 25, 2019
@anapaulagomes anapaulagomes changed the title Improve code comments Improve code comments [WIP] Oct 25, 2019
Copy link
Member

@berinhard berinhard left a comment

Choose a reason for hiding this comment

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

The code looks good for me! I left one small comment on a docstring, but once it's fixed, we can merge this. Do you think we should add black to the project as well?

model_bakery/utils.py Outdated Show resolved Hide resolved
tests/test_baker.py Outdated Show resolved Hide resolved
@anapaulagomes
Copy link
Contributor Author

I still want to double check this before getting it merged, @berinhard. Thanks for your comments!
About black: I'm 100% in but we should do it in a separated PR.

@anapaulagomes anapaulagomes changed the title Improve code comments [WIP] Improve code comments Nov 17, 2019
@anapaulagomes anapaulagomes marked this pull request as ready for review November 17, 2019 11:17
Copy link
Member

@berinhard berinhard left a comment

Choose a reason for hiding this comment

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

Thanks for being careful with the code comments @anapaulagomes! About Black, I've created issue #38 to address that.

@berinhard berinhard merged commit e57b42f into master Nov 20, 2019
@berinhard berinhard deleted the improve-code-docs branch November 20, 2019 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants