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

Add docs FAQ entry on domain name distinctions (pylint dot org vs pylint.readthedocs.io) #10177

Merged
merged 11 commits into from
Jan 13, 2025

Conversation

d33bs
Copy link
Contributor

@d33bs d33bs commented Jan 11, 2025

Type of Changes

Type
βœ“ πŸ“œ Docs

Description

This PR adds an FAQ entry to the docs which helps clarify that pylint dot org is managed outside of this project and that this project is associated with the documentation found at pylint.readthedocs.io . I tried to tie this to the PyPI package in the language within the FAQ entry, as I'm unsure if pylint dot org manages its own distributions somehow, but let me know if there's a better way to state this clearly!

Thank you in advance for any thoughts or feedback!

Closes #8934 (please let me know if you feel this should close the issue instead of ref'ing it!)

Copy link

codecov bot commented Jan 11, 2025

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 95.83%. Comparing base (d94194b) to head (6879eb6).
Report is 4 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #10177   +/-   ##
=======================================
  Coverage   95.83%   95.83%           
=======================================
  Files         174      174           
  Lines       19002    19002           
=======================================
  Hits        18211    18211           
  Misses        791      791           

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 opening the PR ! Let me know what you think of my suggestion. If we use the actual domain name in discussion and not pylint dot org, it helps them with better SEO :)

doc/faq.rst Outdated
@@ -137,3 +137,18 @@ localized using the following rules:
- macOS: "~/Library/Caches/pylint"
- Windows: "C:\Users\<username>\AppData\Local\pylint"
* ".pylint.d" directory in the current directory

What is the difference between pylint.org and pylint.readthedocs.io?
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
What is the difference between pylint.org and pylint.readthedocs.io?
What's the matter with pylint dot org ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for this suggestion! I might try a different approach here to avoid making it seem like pylint dot org is somehow "wrong" or "lesser than" ("what's the matter" is commonly used to indicate there might be a perceived problem) in the spirit of doing no harm.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed this to a more neutral How does the website pylint dot org relate to this project?.

Copy link
Member

Choose a reason for hiding this comment

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

Ho, it's inferior, it's some domain name scalper making banks on the project popularity without doing any work and using outdated doc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I see, I didn't understand that from the issue context; I thought it might have been the original author's company simply allowing for decayed content to persist (maybe out of lack of knowledge or awareness). I'll give another edit a whirl.

doc/faq.rst Outdated Show resolved Hide resolved
doc/whatsnew/fragments/8934.other.rst Outdated Show resolved Hide resolved
@d33bs d33bs changed the title Add docs FAQ entry on domain name distinctions (pylint.org vs pylint.readthedocs.io) Add docs FAQ entry on domain name distinctions (pylint dot org vs pylint.readthedocs.io) Jan 12, 2025
@d33bs
Copy link
Contributor Author

d33bs commented Jan 12, 2025

Thank you @Pierre-Sassoulas for the review! I made some changes based on your feedback, including shifting all language in the PR to avoid the use of the full domain name for pylint dot org.

doc/faq.rst Outdated Show resolved Hide resolved
doc/faq.rst Outdated Show resolved Hide resolved
@Pierre-Sassoulas Pierre-Sassoulas added the Skip news πŸ”‡ This change does not require a changelog entry label Jan 13, 2025
@Pierre-Sassoulas Pierre-Sassoulas enabled auto-merge (squash) January 13, 2025 21:26
@Pierre-Sassoulas
Copy link
Member

Thank you for making the doc better @d33bs !

@Pierre-Sassoulas Pierre-Sassoulas merged commit af7a970 into pylint-dev:main Jan 13, 2025
27 of 28 checks passed
@d33bs d33bs deleted the faq-domain-name-question branch January 14, 2025 17:27
@d33bs
Copy link
Contributor Author

d33bs commented Jan 14, 2025

Thank you @Pierre-Sassoulas for merging this in! Hope it helps regarding the potential for confusion.

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.

Pylint dot org - Add a notice in README to clarify that this website is defunct
2 participants