From 57a9938008b280e82d844456c4843b1e258e2c6b Mon Sep 17 00:00:00 2001 From: Wilfred Tyler Gee Date: Wed, 27 May 2020 13:28:53 -1000 Subject: [PATCH] Update CONTRIBUTING.md Removing section on root-relative imports. --- CONTRIBUTING.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e476f672e..41934e278 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,18 +81,6 @@ for more info._ - File names should be lower case and underscored, not contain spaces. For example, `my_file.py` instead of `My File.py`. - Define any project specific terminology or abbreviations you use in the file you use them. -- Use root-relative imports (i.e. relative to the POCS directory). This means that rather - than using a directory relative imports such as: - ```python - from ..base import PanBase - from ..utils import current_time - ``` - Import from the top-down instead: - ```python - from pocs.base import PanBase - from pocs.utils import current_time - ``` - The same applies to code inside of `peas`. - Test imports are slightly different because `pocs/tests` and `peas/tests` are not Python packages (those directories don't contain an `__init__.py` file). For imports of `pocs` or `peas` code, use root-relative imports as described above. For importing test packages and