Skip to content

test: remove max-doc-length from tox.ini file due to community recommendation #19

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

Merged
mariajgrimaldi merged 1 commit into from
Jul 27, 2021
Merged

test: remove max-doc-length from tox.ini file due to community recommendation #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ignore=D001
[pycodestyle]
exclude = .git,.tox
max-line-length = 120
max-doc-length = 79
Copy link

@MoisesGSalas MoisesGSalas Jul 26, 2021

Choose a reason for hiding this comment

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

Do you want to remove the check altogether and not go for max-doc-length = 120?

Copy link
Member Author

@mariajgrimaldi mariajgrimaldi Jul 26, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

You're right. I was following edx-django-utils configuration. But then I found this: https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html#syntax-and-organization

Please use 79 chars as a limit for docstring lines though, so that the text remains readable.

I think I'm gonna close this issue. Thanks for the review though!

Copy link
Member Author

@mariajgrimaldi mariajgrimaldi Jul 26, 2021

Choose a reason for hiding this comment

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

I fixed it! @MoisesGSalas

max-doc-length = 120

[pydocstyle]
; D101 = Missing docstring in public class
Expand Down