-
Notifications
You must be signed in to change notification settings - Fork 755
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
More fine-grained control of docstring and comment length #906
Comments
I like this proposal. The original "hijack" is from 2014. This one from a year ago. I can't believe there isn't any more input/progress on this topic. For example, if using Click, the docstrings are automatically wrapped at the proper length when using I like constraints that help provide consistency across cli/sphinx/code, especially when it comes to appearance. Having a separate setting would provide that. |
@bstivers I can understand you're coming from a place of frustration but the tone of your comment reads to me as condescending and unnecessarily hostile. All it makes me want to do is reject this because why would I reward such shame-y comments with what you want to result from this. There's been no progress on this because no one has been motivated enough to make progress on it. There hasn't been more input because, as I suspected at the time, this is an incredibly niche ask likely to only dramatically increase the complexity of pycodestyle to benefit less than 1% of users. |
As discussed/hijacked in #344, I proposed to have an option to limit the length of docstring and comments:
max_doc_length
, default tomax_line_length
(current behavior)max_single_doc_length
, default tomax_doc_length + 3
ifmax_doc_length
is set, otherwise tomax_line_length
max_comment_length
, default tomax_doc_length
(current behavior)Answer to @asottile
I added that to the proposal. My rational is, consider these
then the second case actually reaches 75 columns. I'm not sure about others, but I consider
to be quite distasteful.
Answer to @timj
Generally, I have no problem with breaking comments, but in a few places like copyright headers, it's not very nice, like in AGPL or LGPL:
As you can see, the second-last line is 74 columns, and breaking it in any manner makes it look awkward, especially when these should be consistent between different languages.
Also to @brianv0, what's your opinion on this?
The text was updated successfully, but these errors were encountered: