Skip to content

Commit 5e55c08

Browse files
author
Poruri Sai Rahul
authored
Add docstrings to api modules in apptools subpackages (#274)
* DOC : Add docstrings to api modules in apptools subpackages modified: apptools/io/api.py modified: apptools/logger/api.py modified: apptools/naming/api.py modified: apptools/naming/trait_defs/api.py modified: apptools/preferences/api.py modified: apptools/preferences/ui/api.py modified: apptools/scripting/api.py modified: apptools/selection/api.py modified: apptools/type_registry/api.py modified: apptools/undo/action/api.py modified: apptools/undo/api.py * DOC : Add changelog entry new file: docs/releases/upcoming/274.doc.rst
1 parent 9b06f46 commit 5e55c08

File tree

12 files changed

+151
-1
lines changed

12 files changed

+151
-1
lines changed

‎apptools/io/api.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,10 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10+
11+
""" API for the apptools.io subpackage.
12+
13+
- :class:`~.File`
14+
"""
15+
1016
from .file import File

‎apptools/logger/api.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10+
11+
""" API for the apptools.logger subpackage.
12+
13+
- :func:`~.add_log_queue_handler`
14+
- :func:`~.log_point`
15+
- :class:`~.LogFileHandler`
16+
- :attr:`~.FORMATTER`
17+
- :attr:`~.LEVEL`
18+
"""
19+
1020
from .logger import add_log_queue_handler
1121
from .logger import FORMATTER, LEVEL, LogFileHandler
1222
from .log_point import log_point

‎apptools/naming/api.py‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,43 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10+
11+
""" API for the apptools.naming subpackage.
12+
13+
- :class:`~.Address`
14+
- :class:`~.Binding`
15+
- :class:`~.Context`
16+
- :class:`~.DynamicContext`
17+
- :class:`~.DirContext`
18+
- :func:`~.InitialContext`
19+
- :class:`~.InitialContextFactory`
20+
- :class:`~.NamingEvent`
21+
- :attr:`~.naming_manager`
22+
- :class:`~.ObjectFactory`
23+
- :class:`~.ObjectSerializer`
24+
- :class:`~.PyContext`
25+
- :class:`~.PyObjectFactory`
26+
- :class:`~.PyFSContext`
27+
- :class:`~.PyFSContextFactory`
28+
- :class:`~.PyFSInitialContextFactory`
29+
- :class:`~.PyFSObjectFactory`
30+
- :class:`~.PyFSStateFactory`
31+
- :class:`~.Reference`
32+
- :class:`~.Referenceable`
33+
- :class:`~.ReferenceableStateFactory`
34+
- :class:`~.StateFactory`
35+
36+
Custom Exceptions
37+
-----------------
38+
39+
- :class:`~.NamingError`
40+
- :class:`~.InvalidNameError`
41+
- :class:`~.NameAlreadyBoundError`
42+
- :class:`~.NameNotFoundError`
43+
- :class:`~.NotContextError`
44+
- :class:`~.OperationNotSupportedError`
45+
"""
46+
1047
from .exception import NamingError, InvalidNameError, NameAlreadyBoundError
1148
from .exception import NameNotFoundError, NotContextError
1249
from .exception import OperationNotSupportedError

‎apptools/naming/trait_defs/api.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,9 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10+
11+
""" API for the apptools.naming.trait_defs subpackage.
12+
13+
- :attr:`~.NamingInstance`
14+
"""
1015
from .naming_traits import NamingInstance

‎apptools/preferences/api.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,26 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10+
11+
""" API for apptools.preferences subpackage.
12+
13+
- :class:`~.Preferences`
14+
- :class:`~.PreferenceBinding`
15+
- :class:`~.PreferencesHelper`
16+
- :class:`~.ScopedPreferences`
17+
18+
Interfaces
19+
----------
20+
- :class:`~.IPreferences`
21+
22+
Utilities
23+
---------
24+
25+
- :func:`~.get_default_preferences`
26+
- :func:`~.set_default_preferences`
27+
- :func:`~.bind_preference`
28+
"""
29+
1030
from .i_preferences import IPreferences
1131

1232
from .package_globals import get_default_preferences, set_default_preferences

‎apptools/preferences/ui/api.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10+
11+
""" API for the apptools.preferences.ui subpackage.
12+
13+
- :class:`~.IPreferencesPage`
14+
- :class:`~.PreferencesManager`
15+
- :class:`~.PreferencesPage`
16+
"""
17+
1018
from .i_preferences_page import IPreferencesPage
1119

1220
from .preferences_manager import PreferencesManager

‎apptools/scripting/api.py‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,23 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10-
"""Public API for the scripting package.
10+
11+
""" API for the apptools.scripting subpackage.
12+
13+
- :class:`~.Recorder`
14+
- :func:`~.recordable`
15+
- :class:`~.RecorderWithUI`
16+
17+
Custom Exceptions
18+
-----------------
19+
- :class:`~.RecorderError`
20+
21+
Utilities
22+
---------
23+
- :func:`~.get_recorder`
24+
- :func:`~.set_recorder`
25+
- :func:`~.start_recording`
26+
- :func:`~.stop_recording`
1127
"""
1228

1329
from .recorder import Recorder, RecorderError

‎apptools/selection/api.py‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,25 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10+
11+
""" API for the apptools.selection subpackage.
12+
13+
- :class:`~.ListSelection`
14+
- :class:`~.SelectionService`
15+
16+
Interfaces
17+
----------
18+
- :class:`~.ISelection`
19+
- :class:`~.IListSelection`
20+
- :class:`~.ISelectionProvider`
21+
22+
Custom Exceptions
23+
-----------------
24+
- :class:`~.IDConflictError`
25+
- :class:`~.ListenerNotConnectedError`
26+
- :class:`~.ProviderNotRegisteredError`
27+
"""
28+
1029
from .errors import (
1130
IDConflictError,
1231
ListenerNotConnectedError,

‎apptools/type_registry/api.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,11 @@
77
# is also available online at http://www.enthought.com/licenses/BSD.txt
88
#
99
# Thanks for using Enthought open source!
10+
11+
""" API for the apptools.type_registry subpackage.
12+
13+
- :class:`~.LazyRegistry`
14+
- :class:`~.TypeRegistry`
15+
"""
16+
1017
from .type_registry import LazyRegistry, TypeRegistry

‎apptools/undo/action/api.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@
1212
# Description: <Enthought undo package component>
1313
# ------------------------------------------------------------------------------
1414

15+
""" API for apptools.undo.action subpackage.
16+
17+
- :class:`~.CommandAction`
18+
- :class:`~.RedoAction`
19+
- :class:`~.UndoAction`
20+
"""
21+
1522
from pyface.undo.action.api import (
1623
CommandAction,
1724
RedoAction,

0 commit comments

Comments
 (0)