[gnome-music/wip/jfelder/songlistsore-docstring] songliststore: Add missing docstrings
- From: Jean Felder <jfelder src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-music/wip/jfelder/songlistsore-docstring] songliststore: Add missing docstrings
- Date: Fri, 22 Nov 2019 11:54:26 +0000 (UTC)
commit 9a200937a4f1e431f980464c0ac8d586a1d1b296
Author: Jean Felder <jfelder src gnome org>
Date: Fri Nov 22 12:51:42 2019 +0100
songliststore: Add missing docstrings
gnomemusic/songliststore.py | 9 +++++++++
1 file changed, 9 insertions(+)
---
diff --git a/gnomemusic/songliststore.py b/gnomemusic/songliststore.py
index df3c2587..dc9c94a8 100644
--- a/gnomemusic/songliststore.py
+++ b/gnomemusic/songliststore.py
@@ -7,6 +7,10 @@ import gnomemusic.utils as utils
class SongListStore(Gtk.ListStore):
def __init__(self, model):
+ """Initialize SongListStore.
+
+ :param Gio.ListStore model: The songs model to use
+ """
super().__init__()
self._model = Gfm.SortListModel.new(model)
@@ -88,4 +92,9 @@ class SongListStore(Gtk.ListStore):
@GObject.Property(
type=Gio.ListStore, default=None, flags=GObject.ParamFlags.READABLE)
def model(self):
+ """Gets the model of songs sorted.
+
+ :returns: a list model of sorted songs
+ :rtype: Gfm.SortListModel
+ """
return self._model
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]