summaryrefslogtreecommitdiff
path: root/src/cython/CONVENTIONS
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-05-31 15:34:04 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-05-31 15:34:04 +0000
commit7c20f9bf5829aa4ebe26ee59fb0120852dc0a5f3 (patch)
tree7ecb0a94384406746d8283387ceb4f7ccf934f9d /src/cython/CONVENTIONS
parent1e283611d2999003353e57f429bc9a0513fb0508 (diff)
Add CONVENTIONS file to say Gudhi follows PEP8
Add persistence and betti numbers getters git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@1228 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: d52d7e30d3feffe206deb14e741960987ba9fa7c
Diffstat (limited to 'src/cython/CONVENTIONS')
-rw-r--r--src/cython/CONVENTIONS9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/cython/CONVENTIONS b/src/cython/CONVENTIONS
new file mode 100644
index 00000000..804e97f3
--- /dev/null
+++ b/src/cython/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