docs: Reference PEP 8 section about public interface

qiboteam · Oct 16, 2024 · 548d42e · 548d42e
1 parent dec6018
commit 548d42e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/doc/dev/README.md b/doc/dev/README.md
@@ -8,7 +8,7 @@ Try to follow as close as possible [semver](https://semver.org/)
 
 I.e. whether things are private or public, including internal relations.
 
-Cf. [importing guidelines](./import.md)
+Cf. [importing guidelines](./visibility.md)
 
 ## APIs
 

diff --git a/doc/dev/visibility.md b/doc/dev/visibility.md
@@ -2,6 +2,9 @@
 
 Trying to establish some guidelines about importing and "exporting" things
 
+First and foremost, check PEP 8 [dedicated
+section](https://peps.python.org/pep-0008/#public-and-internal-interfaces).
+
 ## Internal imports
 
 1. never import from a place which is not supposed to export
-Original file line number
+Diff line change
@@ Expand Up @@
     I.e. whether things are private or public, including internal relations.
-    Cf. [importing guidelines](./import.md)
+    Cf. [importing guidelines](./visibility.md)
     ## APIs
@@ Expand Down @@