Don't use "import" in example method paths docs to avoid confusion#521
Merged
omab merged 1 commit intoomab:masterfrom Feb 23, 2015
Merged
Don't use "import" in example method paths docs to avoid confusion#521omab merged 1 commit intoomab:masterfrom
omab merged 1 commit intoomab:masterfrom
Conversation
This is for two reasons:
a) Using the verb "import" suggests that the module/function should be
imported which is not true; we want a "dotted path notation" string
rather than a reference to the method.
b) "import" is an invalid module name anyway, so as an example of dotted
path notation it is faulty. (Okay, it might actually be possible using
`types` and `sys.modules` but.. yeah)
Signed-off-by: Chris Lamb <chris@chris-lamb.co.uk>
omab
added a commit
that referenced
this pull request
Feb 23, 2015
Don't use "import" in example method paths docs to avoid confusion
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is for two reasons:
a) Using the verb "import" suggests that the module/function should be
imported which is not true; we want a "dotted path notation" string
rather than a reference to the method.
b) "import" is an invalid module name anyway, so as an example of dotted
path notation it is faulty. (Okay, it might actually be possible using
typesandsys.modulesbut.. yeah)Signed-off-by: Chris Lamb chris@chris-lamb.co.uk