Skip to content

Commit 92ff98f

Browse files
committed
DOC: Remove print_update and documenting logging.
1 parent b7bb133 commit 92ff98f

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

doc/api.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,14 +116,33 @@ optimizations. :class:`~trackpy.framewise_data.PandasHDFStoreBig` is a good gene
116116
That last class cannot be used directly; it is meant to be subclassed
117117
to support other formats. See *Writing Your Own Interface* in the streaming tutoral for more.
118118

119+
Logging
120+
-------
121+
122+
Trackpy issues log messages. This functionality is mainly used to report the
123+
progress of lengthy jobs, but it may be used in the future to report details of
124+
feature-finding and linking for debugging purposes.
125+
126+
When trackpy is imported, it automatically calls `handle_logging()`, which sets
127+
the logging level and attaches a logging handler that plays nicely with
128+
IPython notebooks. You can override this by calling `ignore_logging()` and
129+
configuring the logger however you like.
130+
131+
.. autosummary:
132+
:toctree: generated/
133+
134+
quiet
135+
handle_logging
136+
ignore_logging
137+
`
138+
119139
Utility functions
120140
-----------------
121141

122142
.. autosummary::
123143
:toctree: generated/
124144

125145
utils.fit_powerlaw
126-
utils.print_update
127146

128147
Low-Level API (Advanced)
129148
------------------------

0 commit comments

Comments
 (0)