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 example useless-import-alias message documentation #6151

Merged
merged 8 commits into from
Apr 3, 2022
Merged

Add example useless-import-alias message documentation #6151

merged 8 commits into from
Apr 3, 2022

Conversation

gunungpw
Copy link
Contributor

@gunungpw gunungpw commented Apr 3, 2022

  • Write a good description on what the PR does.

Type of Changes

Type
βœ“ πŸ“œ Docs

Description

  • add example code for useless-import-alias
  • add link PEP 8 in import section

Related: #5953
Closes #6006

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.

For this one there's an argument in #6006, because some prefer not to use __all__ in their API and useless import alias is a signal that something is an API. Could you add something in details.rst to clarify the known issue and about the solution. We can also close the other issue after that.

@gunungpw
Copy link
Contributor Author

gunungpw commented Apr 3, 2022

@Pierre-Sassoulas I already add details.rst about the issue and solution, but don't know if the wording is right

@jacobtylerwalls jacobtylerwalls changed the title Add example uselesss-import-alias message documentation Add example useless-import-alias message documentation Apr 3, 2022
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.

Great, thank you πŸ‘

doc/data/messages/u/useless-import-alias/details.rst Outdated Show resolved Hide resolved
doc/data/messages/u/useless-import-alias/details.rst Outdated Show resolved Hide resolved
@Pierre-Sassoulas Pierre-Sassoulas merged commit a93602d into pylint-dev:main Apr 3, 2022
@gunungpw gunungpw deleted the useless-import-alias branch April 3, 2022 13:55
@Pierre-Sassoulas Pierre-Sassoulas removed this from the 2.14.0 milestone May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

false positive 'useless-import-alias' error for mypy-compatible explicit re-exports
2 participants