diff options
43 files changed, 181 insertions, 30 deletions
diff --git a/src/sugar/activity/activity.py b/src/sugar/activity/activity.py index 4d5fa7c..500143a 100644 --- a/src/sugar/activity/activity.py +++ b/src/sugar/activity/activity.py @@ -26,6 +26,8 @@ interesting buttons for the user, like for example 'exit activity' See the methods of the Activity class below for more information on what you will need for a real activity. + +STABLE. """ # Copyright (C) 2006-2007 Red Hat, Inc. # Copyright (C) 2007-2008 One Laptop Per Child diff --git a/src/sugar/activity/activityfactory.py b/src/sugar/activity/activityfactory.py index 97583a0..e92314d 100644 --- a/src/sugar/activity/activityfactory.py +++ b/src/sugar/activity/activityfactory.py @@ -1,4 +1,3 @@ -"""Shell side object which manages request to start activity""" # Copyright (C) 2006-2007 Red Hat, Inc. # # This library is free software; you can redistribute it and/or @@ -16,6 +15,12 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +"""Shell side object which manages request to start activity + +UNSTABLE. Activities are currently not allowed to run other activities so at +the moment there is no reason to stabilize this API. +""" + import logging import dbus diff --git a/src/sugar/activity/activityhandle.py b/src/sugar/activity/activityhandle.py index 3f4a44c..f255fd5 100644 --- a/src/sugar/activity/activityhandle.py +++ b/src/sugar/activity/activityhandle.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + class ActivityHandle(object): """Data structure storing simple activity metadata""" def __init__( diff --git a/src/sugar/activity/activityservice.py b/src/sugar/activity/activityservice.py index b2f7e15..81bd6dd 100644 --- a/src/sugar/activity/activityservice.py +++ b/src/sugar/activity/activityservice.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +UNSTABLE. It should really be internal to the Activity class. +""" + import logging import dbus diff --git a/src/sugar/activity/bundlebuilder.py b/src/sugar/activity/bundlebuilder.py index ce8787a..ab3679b 100644 --- a/src/sugar/activity/bundlebuilder.py +++ b/src/sugar/activity/bundlebuilder.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import os import sys import zipfile diff --git a/src/sugar/bundle/activitybundle.py b/src/sugar/bundle/activitybundle.py index e74f471..97acc70 100644 --- a/src/sugar/bundle/activitybundle.py +++ b/src/sugar/bundle/activitybundle.py @@ -15,7 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. -"""Sugar activity bundles""" +"""Sugar activity bundles + +UNSTABLE. +""" from ConfigParser import ConfigParser import locale diff --git a/src/sugar/bundle/bundle.py b/src/sugar/bundle/bundle.py index c0138e7..ed0360d 100644 --- a/src/sugar/bundle/bundle.py +++ b/src/sugar/bundle/bundle.py @@ -15,7 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. -"""Sugar bundle file handler""" +"""Sugar bundle file handler + +UNSTABLE. +""" import os import logging diff --git a/src/sugar/bundle/contentbundle.py b/src/sugar/bundle/contentbundle.py index 389fd70..a95ed61 100644 --- a/src/sugar/bundle/contentbundle.py +++ b/src/sugar/bundle/contentbundle.py @@ -15,7 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. -"""Sugar content bundles""" +"""Sugar content bundles + +UNSTABLE. +""" from ConfigParser import ConfigParser import os diff --git a/src/sugar/datastore/datastore.py b/src/sugar/datastore/datastore.py index 9cd22bf..f6df214 100644 --- a/src/sugar/datastore/datastore.py +++ b/src/sugar/datastore/datastore.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import logging import time from datetime import datetime diff --git a/src/sugar/datastore/dbus_helpers.py b/src/sugar/datastore/dbus_helpers.py index 19145d9..9115382 100644 --- a/src/sugar/datastore/dbus_helpers.py +++ b/src/sugar/datastore/dbus_helpers.py @@ -16,6 +16,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +UNSTABLE. Should be internal to the datastore module. +""" + import logging import dbus diff --git a/src/sugar/env.py b/src/sugar/env.py index b9c259f..91e91d3 100644 --- a/src/sugar/env.py +++ b/src/sugar/env.py @@ -16,6 +16,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import os def is_emulator(): diff --git a/src/sugar/graphics/alert.py b/src/sugar/graphics/alert.py index 13a4a51..6cfa0fa 100644 --- a/src/sugar/graphics/alert.py +++ b/src/sugar/graphics/alert.py @@ -25,6 +25,7 @@ create a simple alert message. self.add_alert(alert) alert.show() +STABLE. """ # Copyright (C) 2007, One Laptop Per Child # diff --git a/src/sugar/graphics/animator.py b/src/sugar/graphics/animator.py index 347b1d8..5d5b355 100644 --- a/src/sugar/graphics/animator.py +++ b/src/sugar/graphics/animator.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import time import gobject diff --git a/src/sugar/graphics/combobox.py b/src/sugar/graphics/combobox.py index 4c43f99..4e094ab 100644 --- a/src/sugar/graphics/combobox.py +++ b/src/sugar/graphics/combobox.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gobject import gtk diff --git a/src/sugar/graphics/entry.py b/src/sugar/graphics/entry.py index 08ea3ca..62975da 100644 --- a/src/sugar/graphics/entry.py +++ b/src/sugar/graphics/entry.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gtk import hippo diff --git a/src/sugar/graphics/icon.py b/src/sugar/graphics/icon.py index 40627c7..37af191 100644 --- a/src/sugar/graphics/icon.py +++ b/src/sugar/graphics/icon.py @@ -1,7 +1,3 @@ -""" -A small fixed size picture, typically used to decorate components. - -""" # Copyright (C) 2006-2007 Red Hat, Inc. # # This library is free software; you can redistribute it and/or @@ -19,6 +15,12 @@ A small fixed size picture, typically used to decorate components. # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +A small fixed size picture, typically used to decorate components. + +STABLE. +""" + import re import math import logging diff --git a/src/sugar/graphics/menuitem.py b/src/sugar/graphics/menuitem.py index 3d6764b..70c08f7 100644 --- a/src/sugar/graphics/menuitem.py +++ b/src/sugar/graphics/menuitem.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gtk from sugar.graphics.icon import Icon diff --git a/src/sugar/graphics/notebook.py b/src/sugar/graphics/notebook.py index e159bb3..4965b24 100644 --- a/src/sugar/graphics/notebook.py +++ b/src/sugar/graphics/notebook.py @@ -1,10 +1,3 @@ -"""Notebook class - -This class create a gtk.Notebook() widget supporting -a close button in every tab when the 'can-close-tabs' gproperty -is enabled (True) -""" - # Copyright (C) 2007, Eduardo Silva (edsiper@gmail.com) # # This library is free software; you can redistribute it and/or @@ -22,6 +15,15 @@ is enabled (True) # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +"""Notebook class + +This class create a gtk.Notebook() widget supporting +a close button in every tab when the 'can-close-tabs' gproperty +is enabled (True) + +STABLE. +""" + import gtk import gobject diff --git a/src/sugar/graphics/objectchooser.py b/src/sugar/graphics/objectchooser.py index 861d0ab..1188b04 100644 --- a/src/sugar/graphics/objectchooser.py +++ b/src/sugar/graphics/objectchooser.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import logging import gobject diff --git a/src/sugar/graphics/palette.py b/src/sugar/graphics/palette.py index 71eb8a8..706bc1c 100644 --- a/src/sugar/graphics/palette.py +++ b/src/sugar/graphics/palette.py @@ -16,6 +16,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import logging import gtk diff --git a/src/sugar/graphics/palettegroup.py b/src/sugar/graphics/palettegroup.py index bdae76b..e95b5aa 100644 --- a/src/sugar/graphics/palettegroup.py +++ b/src/sugar/graphics/palettegroup.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gobject _groups = {} diff --git a/src/sugar/graphics/panel.py b/src/sugar/graphics/panel.py index bf3ed24..bc48db8 100644 --- a/src/sugar/graphics/panel.py +++ b/src/sugar/graphics/panel.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gtk class Panel(gtk.VBox): diff --git a/src/sugar/graphics/radiotoolbutton.py b/src/sugar/graphics/radiotoolbutton.py index 1fb18cc..11f962d 100644 --- a/src/sugar/graphics/radiotoolbutton.py +++ b/src/sugar/graphics/radiotoolbutton.py @@ -16,6 +16,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gtk import gobject diff --git a/src/sugar/graphics/roundbox.py b/src/sugar/graphics/roundbox.py index 573344e..28644bc 100644 --- a/src/sugar/graphics/roundbox.py +++ b/src/sugar/graphics/roundbox.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import math import hippo diff --git a/src/sugar/graphics/style.py b/src/sugar/graphics/style.py index 5b74bc5..16b78ed 100644 --- a/src/sugar/graphics/style.py +++ b/src/sugar/graphics/style.py @@ -18,6 +18,8 @@ """ All the constants are expressed in pixels. They are defined for the XO screen and are usually adapted to different resolution by applying a zoom factor. + +STABLE. """ import os diff --git a/src/sugar/graphics/toggletoolbutton.py b/src/sugar/graphics/toggletoolbutton.py index 35c4bf1..9bb2f58 100644 --- a/src/sugar/graphics/toggletoolbutton.py +++ b/src/sugar/graphics/toggletoolbutton.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gobject import gtk diff --git a/src/sugar/graphics/toolbox.py b/src/sugar/graphics/toolbox.py index f0889be..1cfbe93 100644 --- a/src/sugar/graphics/toolbox.py +++ b/src/sugar/graphics/toolbox.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gtk import gobject import hippo diff --git a/src/sugar/graphics/toolbutton.py b/src/sugar/graphics/toolbutton.py index a80c67a..6205b8a 100644 --- a/src/sugar/graphics/toolbutton.py +++ b/src/sugar/graphics/toolbutton.py @@ -16,6 +16,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import logging import gtk diff --git a/src/sugar/graphics/toolcombobox.py b/src/sugar/graphics/toolcombobox.py index 460dcee..16e14bd 100644 --- a/src/sugar/graphics/toolcombobox.py +++ b/src/sugar/graphics/toolcombobox.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gtk import gobject diff --git a/src/sugar/graphics/tray.py b/src/sugar/graphics/tray.py index 21ecbb0..5df7170 100644 --- a/src/sugar/graphics/tray.py +++ b/src/sugar/graphics/tray.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gobject import gtk diff --git a/src/sugar/graphics/window.py b/src/sugar/graphics/window.py index ced5595..1ad2bca 100644 --- a/src/sugar/graphics/window.py +++ b/src/sugar/graphics/window.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import gobject import gtk diff --git a/src/sugar/graphics/xocolor.py b/src/sugar/graphics/xocolor.py index d5e906f..beb9565 100644 --- a/src/sugar/graphics/xocolor.py +++ b/src/sugar/graphics/xocolor.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import random colors = [ diff --git a/src/sugar/network.py b/src/sugar/network.py index aad817a..c700290 100644 --- a/src/sugar/network.py +++ b/src/sugar/network.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +STABLE. +""" + import os import threading import urllib @@ -25,7 +29,6 @@ import gobject import SimpleHTTPServer import SocketServer - __authinfos = {} def _add_authinfo(authinfo): diff --git a/src/sugar/presence/__init__.py b/src/sugar/presence/__init__.py index 3834ab2..1136c19 100644 --- a/src/sugar/presence/__init__.py +++ b/src/sugar/presence/__init__.py @@ -1,11 +1,3 @@ -"""Client-code's interface to the PresenceService - -Provides a simplified API for accessing the dbus service -which coordinates native network presence and sharing -information. This includes both "buddies" and "shared -activities". -""" - # Copyright (C) 2006-2007, Red Hat, Inc. # # This library is free software; you can redistribute it and/or @@ -22,3 +14,11 @@ activities". # License along with this library; if not, write to the # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. + +"""Client-code's interface to the PresenceService + +Provides a simplified API for accessing the dbus service +which coordinates native network presence and sharing +information. This includes both "buddies" and "shared +activities". +""" diff --git a/src/sugar/presence/activity.py b/src/sugar/presence/activity.py index bd41cec..dc02aa1 100644 --- a/src/sugar/presence/activity.py +++ b/src/sugar/presence/activity.py @@ -1,4 +1,3 @@ -"""UI interface to an activity in the presence service""" # Copyright (C) 2007, Red Hat, Inc. # # This library is free software; you can redistribute it and/or @@ -16,6 +15,11 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +"""UI interface to an activity in the presence service + +STABLE. +""" + import logging import dbus diff --git a/src/sugar/presence/buddy.py b/src/sugar/presence/buddy.py index 1030cfc..fab23d2 100644 --- a/src/sugar/presence/buddy.py +++ b/src/sugar/presence/buddy.py @@ -1,4 +1,3 @@ -"""UI interface to a buddy in the presence service""" # Copyright (C) 2007, Red Hat, Inc. # # This library is free software; you can redistribute it and/or @@ -16,11 +15,15 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +"""UI interface to a buddy in the presence service + +STABLE. +""" + import gobject import gtk import dbus - class Buddy(gobject.GObject): """UI interface for a Buddy in the presence service diff --git a/src/sugar/presence/presenceservice.py b/src/sugar/presence/presenceservice.py index 23e0ea0..e2398a8 100644 --- a/src/sugar/presence/presenceservice.py +++ b/src/sugar/presence/presenceservice.py @@ -1,4 +1,3 @@ -"""UI class to access system-level presence object""" # Copyright (C) 2007, Red Hat, Inc. # # This library is free software; you can redistribute it and/or @@ -16,6 +15,11 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +"""UI class to access system-level presence object + +STABLE. +""" + import logging import dbus diff --git a/src/sugar/presence/sugartubeconn.py b/src/sugar/presence/sugartubeconn.py index 18113fe..954ef67 100644 --- a/src/sugar/presence/sugartubeconn.py +++ b/src/sugar/presence/sugartubeconn.py @@ -1,4 +1,3 @@ -"""Subclass of TubeConnection that converts handles to Sugar Buddies""" # Copyright (C) 2008 One Laptop Per Child # # This program is free software; you can redistribute it and/or modify @@ -15,6 +14,10 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +"""Subclass of TubeConnection that converts handles to Sugar Buddies + +STABLE. +""" from telepathy.constants import ( CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES) diff --git a/src/sugar/presence/tubeconn.py b/src/sugar/presence/tubeconn.py index c2f67e6..8606db6 100644 --- a/src/sugar/presence/tubeconn.py +++ b/src/sugar/presence/tubeconn.py @@ -16,6 +16,9 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +""" +STABLE. +""" __all__ = ('TubeConnection',) __docformat__ = 'reStructuredText' diff --git a/src/sugar/profile.py b/src/sugar/profile.py index ae54022..edfda86 100644 --- a/src/sugar/profile.py +++ b/src/sugar/profile.py @@ -1,4 +1,3 @@ -"""User settings/configuration loading""" # Copyright (C) 2006-2007, Red Hat, Inc. # # This library is free software; you can redistribute it and/or @@ -16,6 +15,11 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +"""User settings/configuration loading. + +DEPRECATED. We are using GConf now to store preferences. +""" + import gconf import os import logging diff --git a/src/sugar/session.py b/src/sugar/session.py index a3fb5e8..0978be8 100644 --- a/src/sugar/session.py +++ b/src/sugar/session.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +UNSTABLE. Used only internally by jarabe. +""" + import os from sugar import _sugarext diff --git a/src/sugar/util.py b/src/sugar/util.py index c365dce..c8bdfb1 100644 --- a/src/sugar/util.py +++ b/src/sugar/util.py @@ -16,6 +16,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +UNSTABLE. We have been adding helpers randomly to this module. +""" + import os import time import sha diff --git a/src/sugar/wm.py b/src/sugar/wm.py index 47356a5..4ec9a12 100644 --- a/src/sugar/wm.py +++ b/src/sugar/wm.py @@ -15,6 +15,10 @@ # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. +""" +UNSTABLE. Used only internally by Activity and jarabe. +""" + import gtk def get_activity_id(wnck_window): |