-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add docs FAQ entry on domain name distinctions (pylint dot org
vs pylint.readthedocs.io)
#10177
Conversation
There was a problem hiding this 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? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the difference between pylint.org and pylint.readthedocs.io? | |
What's the matter with pylint dot org ? |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Co-authored-by: Pierre Sassoulas <[email protected]>
for more information, see https://pre-commit.ci
β¦ylint into faq-domain-name-question
pylint dot org
vs pylint.readthedocs.io)
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 |
for more information, see https://pre-commit.ci
Thank you for making the doc better @d33bs ! |
Thank you @Pierre-Sassoulas for merging this in! Hope it helps regarding the potential for confusion. |
Type of Changes
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 ifpylint 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!)