[doc] Add an example for 'non-ascii-file-name'

[Pierre-Sassoulas]

Type of Changes

	Type
✓	📜 Docs

Description

Move links to related.rst, and upgrade the message shown for python 3.5+

Replace #8324, refs #5953

[codecov]

Codecov Report

Merging #8340 (30258f2) into main (8bf1120) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8340   +/-   ##
=======================================
  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% <ø> (ø)

[ollie-iterators]

This was a tricky issue to work on. Good job on the pull request and I like that you used the file name "not_better", very funny.

[mbyrnepr2]

Is this meant to be part of this MR?

[Pierre-Sassoulas]

We forgot to generate the doc previousely because of #6736

[mbyrnepr2]

I'm not sure the rationale behind the (empty) good/bad.py file or the good/not_better.py files?

[mbyrnepr2]

Just a few small comments :)

[Pierre-Sassoulas]

I'm not sure the rationale behind the (empty) good/bad.py file or the good/not_better.py files?

The problem is in the name of the file so we don't need any content imo. Maybe something like """'à' is not an ascii character but the file is named 'bàd.py'"""' ?

[mbyrnepr2]

I'm not sure the rationale behind the (empty) good/bad.py file or the good/not_better.py files?

The problem is in the name of the file so we don't need any content imo. Maybe something like """'à' is not an ascii character but the file is named 'bàd.py'"""' ?

I meant the file paths themselves. What does good/bad.py mean? 😄

[Pierre-Sassoulas]

I meant the file paths themselves. What does good/bad.py mean?

Ha, the doc framework render it as "correct code" vs "bad code" automatically see https://pylint--8340.org.readthedocs.build/en/8340/user_guide/messages/warning/non-ascii-file-name.html. There's two files because we assumed that a directory could be used only if there was multiple file to demonstrate and if there's only one file it need to be named bad.py.

[github-actions]

🤖 According to the primer, this change has no effect on the checked open source code. 🤖🎉

This comment was generated for commit 30258f2

[mbyrnepr2]

I meant the file paths themselves. What does good/bad.py mean?

Ha, the doc framework render it as "correct code" vs "bad code" automatically see https://pylint--8340.org.readthedocs.build/en/8340/user_guide/messages/warning/non-ascii-file-name.html. There's two files because we assumed that a directory could be used only if there was multiple file to demonstrate and if there's only one file it need to be named bad.py.

Awesome 😎