Reference custom widget guide in TerminalWriter.progress

gorakhargosh · Mar 12, 2011 · f062313 · f062313
1 parent d287991
commit f062313
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/brownie/terminal/__init__.py b/brownie/terminal/__init__.py
@@ -570,6 +570,8 @@ def progress(self, description, maxsteps=None, widgets=None):
         reusable if you need another object, call this method again. If you
         attempt to write to the :attr:`stream` while using a progress bar the
         behaviour is undefined.
+
+        .. seealso:: :ref:`creating-widgets`
         """
         return ProgressBar.from_string(
             description, self, maxsteps=maxsteps, widgets=None

diff --git a/docs/guides/widgets.rst b/docs/guides/widgets.rst
@@ -1,3 +1,5 @@
+.. _creating-widgets:
+
 Creating Progress Bar Widgets
 =============================