summaryrefslogtreecommitdiff
path: root/src/python/CONVENTIONS
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-09-10 13:47:00 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-09-10 13:47:00 +0200
commit27535b78cba069a2870c9b0a322c4fd29b1a7219 (patch)
tree4c6b3c1f5d93f3512ea492e58db424b7477a3b75 /src/python/CONVENTIONS
parent5e8144e8ddb4a39f9f4e60a9fafb5cc57f96acac (diff)
parent9d5ddcac38d43c9df813c0ca4a37b7dc48c68913 (diff)
Merge remote-tracking branch 'upstream/master' into sklearn_tda
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