summaryrefslogtreecommitdiff
path: root/src/python/CONVENTIONS
diff options
context:
space:
mode:
Diffstat (limited to 'src/python/CONVENTIONS')
-rw-r--r--src/python/CONVENTIONS9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/python/CONVENTIONS b/src/python/CONVENTIONS
new file mode 100644
index 00000000..804e97f3
--- /dev/null
+++ b/src/python/CONVENTIONS
@@ -0,0 +1,9 @@
+Gudhi is following PEP8 conventions.
+
+Please refer to:
+https://www.python.org/dev/peps/pep-0008/
+
+A summary:
+ - modules (filenames) should have short, all-lowercase names, and they can contain underscores.
+ - packages (directories) should have short, all-lowercase names, preferably without underscores.
+ - classes should use the CapWords convention. \ No newline at end of file