sugarlabs/sugar-toolkit-gtk3
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs - move get_activity_root description

Browse Source 
When it was moved from the class to the module, the full description did
not move with it.
This commit is contained in:
James Cameron 2019-01-31 08:06:13 +11:00
parent f228909710
commit 6345da8e07
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/sugar3/activity/activity.py
View File

@ -727,20 +727,6 @@ class Activity(Window, Gtk.Container):
''' '''
Deprecated. This part of the API has been moved Deprecated. This part of the API has been moved
out of this class to the module itself out of this class to the module itself
Returns:
str: a path for saving Activity specific preferences, etc.
Returns a path to the location in the filesystem where the activity can
store activity related data that doesn't pertain to the current
execution of the activity and thus cannot go into the DataStore.
Currently, this will return something like
~/.sugar/default/MyActivityName/
Activities should ONLY save settings, user preferences and other data
which isn't specific to a journal item here. If (meta-)data is in
anyway specific to a journal entry, it MUST be stored in the DataStore.
''' '''
return get_activity_root() return get_activity_root()
@ -1497,6 +1483,19 @@ def get_activity_root():
''' '''
Returns: Returns:
str: a path for saving Activity specific preferences, etc. str: a path for saving Activity specific preferences, etc.
Returns a path to the location in the filesystem where the
activity can store activity related data that doesn't pertain to
the current execution of the activity and thus cannot go into the
DataStore.
Currently, this will return something like
~/.sugar/default/MyActivityName/
Activities should ONLY save settings, user preferences and other
data which isn't specific to a journal item here. If (meta-)data
is in anyway specific to a journal entry, it MUST be stored in the
DataStore.
''' '''
if os.environ.get('SUGAR_ACTIVITY_ROOT'): if os.environ.get('SUGAR_ACTIVITY_ROOT'):
return os.environ['SUGAR_ACTIVITY_ROOT'] return os.environ['SUGAR_ACTIVITY_ROOT']