Skip to content

Commit

Permalink
Minor doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
avylove committed Oct 10, 2017
1 parent 9df5744 commit 212f98a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions doc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Examples
Basic
-----

For a basic status bar, invoke the :py:class:`Counter` class directly.
For a basic status bar, invoke the :py:class:`~enlighten.Counter` class directly.

.. code-block:: python
Expand All @@ -32,9 +32,9 @@ Advanced
To maintain multiple progress bars simultaneously or write to the console, a manager is required.

Advanced output will only work when the output stream, :py:data:`sys.stdout` by default,
is attached to a TTY. :py:func:`get_manager` should be used to get a manager instance.
It will return a :py:class:`NullManager` instance if the stream is not attached to a TTY
and a :py:class:`Manager` instance if it is.
is attached to a TTY. :py:func:`~enlighten.get_manager` can be used to get a manager instance.
It will return a disabled :py:class:`~enlighten.Manager` instance if the stream is not attached to a TTY
and an enabled instance if it is.

.. code-block:: python
Expand All @@ -57,7 +57,7 @@ and a :py:class:`Manager` instance if it is.
Counters
--------

The :py:class:`Counter` class has two output formats, progress bar and counter.
The :py:class:`~enlighten.Counter` class has two output formats, progress bar and counter.

The progress bar format is used when a total is not :py:data:`None` and the count is less than the
total. If neither of these conditions are met, the counter format is used:
Expand Down
2 changes: 1 addition & 1 deletion doc/patterns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ output redirection occurs.
enableCounter = config['useCounter'] and stream.isatty()
manager = enlighten.Manager(stream=config['stream'], enabled=enableCounter)
The :py:func:`get_manager` function slightly simplifies this
The :py:func:`~enlighten.get_manager` function slightly simplifies this

.. code-block:: python
Expand Down
2 changes: 1 addition & 1 deletion pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ disable=no-else-return
spelling-dict=en_US

# List of comma separated words that should not be checked.
spelling-ignore-words=Avram, Args, assertRaisesRegexp, assertRegexpMatches, assertNotRegexpMatches, BaseManager, bool, desc, html, incr, kwargs, len, Lubkin, meth, Mozilla, MPL, noqa, NullManager, pragma, py, redirector, resize, resizing, setscroll, sphinxcontrib, ss, stdout, stderr, str, sys, TestCase, tty, TTY, tuple, unicode, unittest
spelling-ignore-words=Avram, Args, assertRaisesRegexp, assertRegexpMatches, assertNotRegexpMatches, BaseManager, bool, desc, html, incr, kwargs, len, Lubkin, meth, Mozilla, MPL, noqa, pragma, py, redirector, resize, resizing, setscroll, sphinxcontrib, ss, stdout, stderr, str, sys, TestCase, tty, TTY, tuple, unicode, unittest

0 comments on commit 212f98a

Please sign in to comment.