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

Proposal: further limit line length for comments/docstrings. #13

Open
jhodgdev opened this issue Jan 20, 2022 · 5 comments
Open

Proposal: further limit line length for comments/docstrings. #13

jhodgdev opened this issue Jan 20, 2022 · 5 comments

Comments

@jhodgdev
Copy link

The most comfortable width for reading extended pieces of text (such as docstrings) is fewer than 70 characters. I would propose we introduce a new rule limiting the width of docstrings. I know Python recommends 72 as a max-length for docstrings but my own preference would be 66/68. I'd be interested in what others think of the idea.
@kozross
Copy link
Member

kozross commented Jan 20, 2022

By this I assume you mean Haddocks? Or comments in general?

@jhodgdev
Copy link
Author

My preference would be comments in general.

@kozross
Copy link
Member

kozross commented Jan 21, 2022

I'm not opposed.

@Benjmhart Thoughts?

@jhodgdev
Copy link
Author

In case it wasn't clear: by comments in general I would include docstrings.

@jhodgdev
Copy link
Author

jhodgdev commented Feb 1, 2022

Any movement on this @kozross @Benjmhart ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kozross @jhodgdev