Skip to content

Commit 338c76c

Browse files
committed
Documentation: Add in @dgmcdonna suggestions/corrections
1 parent 3b21b35 commit 338c76c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CODING_STYLE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ This is heavily based upon https://google.github.io/styleguide/pyguide.html with
1414
Imports
1515
-------
1616

17-
Use import statements for packages and modules only, not for individual types, classes, or functions and ideally not aliased naming would cause confusion. This is to prevent people importing an imported method (which can lead to confusion and add in an unnecessary dependency in the import chain).
17+
Use import statements for packages and modules only, not for individual types, classes, or functions and ideally not aliased unless the imported name would cause confusion. This is to prevent people from importing something that was itself imported from elsewhere (which can lead to confusion and add in an unnecessary dependency in the import chain).
1818

1919
* Use `import x` for importing packages and modules.
20-
* Use `from x import y where x` is the package prefix and y is the module name with no prefix.
20+
* Use `from x import y` where x is the package prefix and y is the module name with no prefix.
2121
* Use `from x import y as z` in any of the following circumstances:
2222
* Two modules named `y` are to be imported.
2323
* `y` conflicts with a top-level name defined in the current module.

0 commit comments

Comments
 (0)