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

Improve docs for py-version #5038

Open
cdce8p opened this issue Sep 17, 2021 · 0 comments
Open

Improve docs for py-version #5038

cdce8p opened this issue Sep 17, 2021 · 0 comments
Labels
Documentation 📗 Enhancement ✨ Improvement to a component Hacktoberfest Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation

Comments

@cdce8p
Copy link
Member

cdce8p commented Sep 17, 2021

Followup to #5019 and #5024

The current documentation around the py-version setting introduced in 2.11 could be improved.

  • Conflicting default values -> Default is autogenerated from sys.version_info. Likely requires an exception to not show a default value Small py-version improvements #5069
  • Explain best practices
    • Most users should default to running pylint with the oldest Python version their project supports
    • In some cases it's useful to set py-version to allow running pylint with newer versions. E.g. when pylint is used together with a pre-commit hook and most development happens on a newer Python version.
    • Setting py-version will only hide suggestions for features that aren't included in all (by a project supported) Python versions.
@cdce8p cdce8p added Help wanted 🙏 Outside help would be appreciated, good for new contributors Documentation 📗 labels Sep 17, 2021
@cdce8p cdce8p added the Enhancement ✨ Improvement to a component label Sep 17, 2021
@Pierre-Sassoulas Pierre-Sassoulas added the Needs PR This issue is accepted, sufficiently specified and now needs an implementation label Jun 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📗 Enhancement ✨ Improvement to a component Hacktoberfest Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Development

No branches or pull requests

2 participants