8000 DOC: line length of rst files should be kept lower than 80 characters · Issue #12871 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC: line length of rst files should be kept lower than 80 characters #12871

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
Closed
albertcthomas opened this issue Dec 27, 2018 · 10 comments · Fixed by #12883
Closed

DOC: line length of rst files should be kept lower than 80 characters #12871

albertcthomas opened this issue Dec 27, 2018 · 10 comments · Fixed by #12883

Comments

@albertcthomas
Copy link
Contributor
albertcthomas commented Dec 27, 2018 •
edited
Loading

I don't think this is written in the doc. Perhaps this should be added to the contributing section.
@adrinjalali
Copy link
Member

It seems to be more of a guideline though, we don't strictly follow it even for new docs. Although, I'm in favor of following it a bit more than what we do now.

@adrinjalali
Copy link
Member

I also wouldn't mind that for cython code.

@albertcthomas
Copy link
Contributor Author

It seems to be more of a guideline though, we don't strictly follow it even for new docs.

Ok. I thought it was more like a requirement as I see comments about it in reviews.

@adrinjalali
Copy link
Member

I guess that's because some of us treat it as a "requirement" :P

@qinhanmin2014
Copy link
Member

If we add these requirements, we'll need to add some checks, I guess it's not worthwhile to waste our time here.
Also, it seems difficult to keep line length in tables.

@adrinjalali
Copy link
Member

Adding it to the contributing guide as a guideline and not a requirement doesn't require checks really, and would encourage people to keep the lines short and not be surprised when we ask them to shorten the lines.

I don't see how that would hurt.

@qinhanmin2014
Copy link
Member

Is it possible to keep line length < 80 in tables? e.g., https://github.com/scikit-learn/scikit-learn/blob/master/doc/modules/model_evaluation.rst#common-cases-predefined-values

@NicolasHug
Copy link
Member

It's not possible either for long links, but it is still useful to write this as a guideline somewhere. Having a <80 line length is always useful for those of us with small screens, whether you're writing Python code or not.

@qinhanmin2014
Copy link
Member

It's not possible either for long links, but it is still useful to write this as a guideline somewhere. Having a <80 line length is always useful for those of us with small screens, whether you're writing Python code or not.

+1 from my side. Just a bit worried whether there're too many guidelines now :)

@albertcthomas
Copy link
Contributor Author
albertcthomas commented Dec 28, 2018 •
edited
Loading

Thanks for your inputs :). I will just add a sentence in the Guidelines for writing documentation, saying that it is better if lines can be <80 characters when possible.

@albertcthomas albertcthomas mentioned this issue Dec 28, 2018
Merged
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

Successfully merging a pull request may close this issue.

[MRG] DOC add sentence about line length of rst files albertcthomas/scikit-learn
4 participants
@NicolasHug @adrinjalali @qinhanmin2014 @albertcthomas
0