Skip to content

Commit

Permalink
docs - move get_activity_root description
Browse files Browse the repository at this point in the history
When it was moved from the class to the module, the full description did
not move with it.
  • Loading branch information
quozl committed Jan 30, 2019
1 parent f228909 commit 6345da8
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions src/sugar3/activity/activity.py
Original file line number Diff line number Diff line change
Expand Up @@ -727,20 +727,6 @@ def get_activity_root(self):
'''
Deprecated. This part of the API has been moved
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()

Expand Down Expand Up @@ -1497,6 +1483,19 @@ def get_activity_root():
'''
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.
'''
if os.environ.get('SUGAR_ACTIVITY_ROOT'):
return os.environ['SUGAR_ACTIVITY_ROOT']
Expand Down

0 comments on commit 6345da8

Please sign in to comment.