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

Work on documentation for non-ascii-file-name #8324

Closed
wants to merge 16 commits into from
Closed

Work on documentation for non-ascii-file-name #8324

wants to merge 16 commits into from

Conversation

ollie-iterators
Copy link
Contributor

@ollie-iterators ollie-iterators commented Feb 21, 2023

Type of Changes

Type
βœ“ πŸ”¨ Refactoring
βœ“ πŸ“œ Docs

Description

Working on documentation for non-ascii-file-name

This is because while the issue (https://bugs.python.org/issue20485) that caused this issue has been fixed since Python 3.5. It is still not recommended to use non-ascii characters in a filename.

This is the PR that fixed the issue: python/cpython#64684 (comment).

Refs #7897

@Pierre-Sassoulas Pierre-Sassoulas added the Maintenance Discussion or action around maintaining pylint or the dev workflow label Feb 21, 2023
@Pierre-Sassoulas Pierre-Sassoulas added this to the 2.17.0 milestone Feb 21, 2023
@codecov
Copy link

codecov bot commented Feb 21, 2023

Codecov Report

Merging #8324 (9ee4f49) into main (8bf1120) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #8324   +/-   ##
=======================================
  Coverage   95.46%   95.46%           
=======================================
  Files         177      177           
  Lines       18704    18704           
=======================================
  Hits        17856    17856           
  Misses        848      848           
Impacted Files Coverage Ξ”
pylint/checkers/non_ascii_names.py 100.00% <ΓΈ> (ΓΈ)

@github-actions

This comment has been minimized.

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.

This need a changelog message, and a cleanup of the existing code in the checkers, this is not going to be easy, a maintainer or someone experienced should probably do it. Also the current MR need to justify the removal if someone read it later.

@ollie-iterators
Copy link
Contributor Author

Ok, I updated the MR

@github-actions

This comment has been minimized.

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 for adding the description and the changelog :) Next step would be to remove all the code related to this (functional tests, all the part of the pylint code specific to this check), do you want to do it or should we take over ?

@ollie-iterators
Copy link
Contributor Author

Thanks for adding the description and the changelog :) Next step would be to remove all the code related to this (functional tests, all the part of the pylint code specific to this check), do you want to do it or should we take over ?

Thanks, but I think I'll try to do it

@ollie-iterators
Copy link
Contributor Author

Ok, I removed non-ascii-file-name from all the files except for full.rst, summary.rst and the files that are necessary to show that it was removed.

@github-actions

This comment has been minimized.

@ollie-iterators ollie-iterators changed the title Adding non-ascii-file-name to deletedMessages Add py-version to non-ascii-file-name Feb 22, 2023
@Pierre-Sassoulas Pierre-Sassoulas added Documentation πŸ“— Skip news πŸ”‡ This change does not require a changelog entry labels Feb 22, 2023
@Pierre-Sassoulas Pierre-Sassoulas removed this from the 2.17.0 milestone Feb 22, 2023
@Pierre-Sassoulas Pierre-Sassoulas removed the Maintenance Discussion or action around maintaining pylint or the dev workflow label Feb 22, 2023
@Pierre-Sassoulas
Copy link
Member

All right thank you for reverting. Let's simply document the message here.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

doc/user_guide/checkers/features.rst Outdated Show resolved Hide resolved
doc/data/messages/n/non-ascii-file-name/pylintrc Outdated Show resolved Hide resolved
@github-actions

This comment has been minimized.

@ollie-iterators ollie-iterators changed the title Add py-version to non-ascii-file-name Work on documentation for non-ascii-file-name Feb 23, 2023
@github-actions

This comment has been minimized.

@github-actions
Copy link
Contributor

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

This comment was generated for commit 9ee4f49

@Pierre-Sassoulas
Copy link
Member

Thank you for working on this. Sorry I'm going to close because the first link is just something that point to PEP489 that we already linked, and the second link point to a list of non ascii character that is not relevant to the issue. Also we can actually document the problem properly see #8340

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