Clarify documentation for consider-using-from-import #4695
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The
consider-using-from-import
checker only works on submodule imports, not member imports because, e.g.,import pandas.DataFrame
is not valid syntax (import <member>
). This PR removes "member" from the documentation and changes the example to a submodule import.By the way, I could not find a justification for this checker in the documentation or in the PR that created it. Is it that the
from ... import
syntax uses less characters? (Personally, I preferimport a.b as b
tofrom a import b
to avoid problems with someone later definingb
as a member ina.py
and that taking precedence over the submodule import but I didn't know if I was missing another advantage to thefrom
syntax).Type of Changes