Mark modules as STABLE/UNSTABLE/DEPRECATED.

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

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

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__(

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

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

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

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

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

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

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

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():

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
 #

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

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
 

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
 

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

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
 

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
 

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

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

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 = {}

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):

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
 

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

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

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
 

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

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

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
 

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
 

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
 

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 = [

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):

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".
+"""

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

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
     

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

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)

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'

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

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

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

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):