[gnome-music] README: Add blurb on coding style
- From: Marinus Schraal <mschraal src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-music] README: Add blurb on coding style
- Date: Tue, 7 Jun 2016 22:43:19 +0000 (UTC)
commit dd6d1713ce2f5f0be36a539f02d94d57c121cb7b
Author: Marinus Schraal <mschraal src gnome org>
Date: Sun May 22 23:40:14 2016 +0200
README: Add blurb on coding style
Add some guidelines on coding style, see
https://bugzilla.gnome.org/show_bug.cgi?id=765593 for more info.
README | 21 +++++++++++++++++++--
1 files changed, 19 insertions(+), 2 deletions(-)
---
diff --git a/README b/README
index 52eb74f..a87c632 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,19 @@ 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/
+
+The content of docstrings uses the Sphinx markup style:
+http://www.sphinx-doc.org/
+
+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]