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

doc unexpected-line-ending-format #8255

Merged

Conversation

hofrob
Copy link
Contributor

@hofrob hofrob commented Feb 10, 2023

Type of Changes

Type
βœ“ πŸ“œ Docs

Description

Add doc for unexpected-line-ending-format / C0328

Refs #5953

@hofrob hofrob force-pushed the doc-unexpected-line-ending-format branch from 1fcd864 to 58e95c0 Compare February 10, 2023 11:58
@codecov
Copy link

codecov bot commented Feb 10, 2023

Codecov Report

Merging #8255 (9625cb8) into main (32e1545) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #8255   +/-   ##
=======================================
  Coverage   95.46%   95.46%           
=======================================
  Files         177      177           
  Lines       18691    18698    +7     
=======================================
+ Hits        17843    17850    +7     
  Misses        848      848           
Impacted Files Coverage Ξ”
pylint/checkers/variables.py 97.30% <0.00%> (+<0.01%) ⬆️
pylint/pyreverse/main.py 93.87% <0.00%> (+0.54%) ⬆️

@Pierre-Sassoulas Pierre-Sassoulas added Documentation πŸ“— Skip news πŸ”‡ This change does not require a changelog entry labels Feb 10, 2023
@hofrob hofrob force-pushed the doc-unexpected-line-ending-format branch from 58e95c0 to 7008fd1 Compare February 10, 2023 12:06
@hofrob
Copy link
Contributor Author

hofrob commented Feb 10, 2023

It's not that easy to commit an actual file with CRLF if all your tools are trying to smart and help you "do the right thing" 😬

@Pierre-Sassoulas
Copy link
Member

Yes you'd need to modify our .gitattributes for that. But it's impossible to see that you did the right thing while reading the doc though :) Maybe something that don't need a bad/good that we could handle in #7897 with a nice story about the meaning and history of CRLF and type printer.

@hofrob
Copy link
Contributor Author

hofrob commented Feb 10, 2023

Right now it's correct, but you're right, this is not visible in the docs. I added inline comments like in the missing-final-newline docs.

I'm thinking about adding an explanation in a details.rst.

@Pierre-Sassoulas
Copy link
Member

Might want to link this https://stackoverflow.com/a/6521730/2519059 and this https://stackoverflow.com/a/10855862/2519059 in related too.

@hofrob hofrob force-pushed the doc-unexpected-line-ending-format branch from 7008fd1 to fed5ba4 Compare February 11, 2023 11:50
@hofrob
Copy link
Contributor Author

hofrob commented Feb 11, 2023

Ok, those links are awesome and have all the info needed (I think). I added those and a link to the awesome gitattributes template repo to related.rst now.

@hofrob hofrob force-pushed the doc-unexpected-line-ending-format branch 3 times, most recently from c938bee to 56487ce Compare February 11, 2023 12:22
@hofrob
Copy link
Contributor Author

hofrob commented Feb 11, 2023

I don't get it. It worked yesterday. Now it doesn't anymore. The bad.py file has CRLF when I check it out locally. But something along the way replaces them with LF again.

🀷

.gitattributes Outdated Show resolved Hide resolved
@hofrob hofrob force-pushed the doc-unexpected-line-ending-format branch from 56487ce to 9625cb8 Compare February 12, 2023 15:54
@Pierre-Sassoulas Pierre-Sassoulas merged commit d1b55f4 into pylint-dev:main Feb 12, 2023
@hofrob hofrob deleted the doc-unexpected-line-ending-format branch February 24, 2023 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation πŸ“— Skip news πŸ”‡ This change does not require a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants