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

Update docs to explain escape character not valid #7103

Merged
merged 2 commits into from
Jul 2, 2022

Conversation

tbennett0
Copy link
Contributor

@tbennett0 tbennett0 commented Jun 30, 2022

Type of Changes

Type
βœ“ πŸ“œ Docs

Description

This just adds the note from #5415 to docs to explain that \ is not valid in ignore-paths per #5398 (comment) because it also currently is needed to support Windows path normalization. This will help avoid additional issues being created (like the one I created in #7089 and also someone else in #7094) to reduce the burden on pylint maintainers/developers.

Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

Thank you for contributing to pylint ! Indeed we should have documented this better. I think the file you modified is autogenerated, could you search for the Python file with the same text and modify this one instead, please ?

@Pierre-Sassoulas Pierre-Sassoulas added Documentation πŸ“— Waiting on author Indicate that maintainers are waiting for a message of the author labels Jul 1, 2022
@coveralls
Copy link

coveralls commented Jul 2, 2022

Pull Request Test Coverage Report for Build 2600560848

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 95.358%

Totals Coverage Status
Change from base Build 2591975912: 0.0%
Covered Lines: 16702
Relevant Lines: 17515

πŸ’› - Coveralls

@github-actions

This comment has been minimized.

@Pierre-Sassoulas Pierre-Sassoulas removed the Waiting on author Indicate that maintainers are waiting for a message of the author label Jul 2, 2022
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

Thanks a lot, and congratulation on becoming a pylint contributor :) !

@Pierre-Sassoulas Pierre-Sassoulas merged commit c2c2f51 into pylint-dev:main Jul 2, 2022
@tbennett0 tbennett0 deleted the patch-1 branch July 2, 2022 06:27
@github-actions
Copy link
Contributor

github-actions bot commented Jul 2, 2022

πŸ€– According to the primer, this change has no effect on the checked open source code. πŸ€–πŸŽ‰

This comment was generated for commit bf667ae

@tbennett0
Copy link
Contributor Author

tbennett0 commented Jul 21, 2022

@Pierre-Sassoulas it looks the the auto-upgrading tools rst doc removed my escape of the \ and now it doesn't render correctly in docs, rendering as:

Because '' represents the directory delimiter on Windows systems, it can't be used as an escape character.

What's the best way around that? Do I need to escape it again?

@Pierre-Sassoulas
Copy link
Member

Does double escape work ? \\ (sometime even \\\\)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants