[gnome-music/wip/mschraal/stylecleanup: 1/4] README: Add blurb on coding style



commit fec0963451c5ff601a8fc43fb3eda255c583f04a
Author: Marinus Schraal <mschraal src gnome org>
Date:   Sun May 22 23:40:14 2016 +0200

    README: Add blurb on coding style
    
    Add some suggestions on coding style, see
    https://bugzilla.gnome.org/show_bug.cgi?id=765593 for more info.

 README |   18 ++++++++++++++++--
 1 files changed, 16 insertions(+), 2 deletions(-)
---
diff --git a/README b/README
index 52eb74f..279a70b 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-GNOME Music 3.19.90 Alpha
-========================
+GNOME Music
+===========
 
 Music is the new GNOME music playing application.
 
@@ -24,6 +24,7 @@ $ jhbuild build gnome-music
 Finally, start gnome music with:
 $ jhbuild run gnome-music
 
+
 === Troubleshooting ===
 
 Jhbuild fires import errors for python packages like:
@@ -32,3 +33,16 @@ Do:
  $ jhbuild shell
  $ export PYTHONPATH=/opt/gnome/lib/python3.3/site-packages:/opt/gnome/lib64/python3.3/site-packages
  $ gnome-music
+
+
+=== Coding style ===
+
+GNOME Music is written in Python and aspires to adhere to the coding style described in PEP-8:
+https://www.python.org/dev/peps/pep-0008/
+
+Use of docstrings is recommended following PEP-257:
+https://www.python.org/dev/peps/pep-0257/
+
+Use PyGI shorthands for manipulating GtkTreeModel:
+ model[iter][0] = "artist"
+ artist, title = model[iter][1, 4]


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]