Skip to content

Commit 668dce4

Browse files
author
ch4rlie
committed
Fix ambiguous reference dictation module docs
The reference to the DictationContainerBase.format() method from the module-level docstring was ambiguous, so I made it absolute to remove the ambiguity. I also changed the reference to the DictationContainerBase.words property to be of the attr role instead of the previous meth role.
1 parent 06b0fc9 commit 668dce4

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

dragonfly/engines/base/dictation.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,10 @@
2626
within voice-commands. It offers access to both the raw spoken-form words
2727
and be formatted written-form text.
2828
29-
The formatted text can be retrieved using :meth:`.format` or simply by
30-
calling ``str(...)`` on a dictation container object. A tuple of the raw
31-
spoken words can be retrieved using :meth:`.words`.
29+
The formatted text can be retrieved using
30+
:meth:`~DictationContainerBase.format` or simply by calling ``str(...)``
31+
on a dictation container object. A tuple of the raw spoken words can be
32+
retrieved using :attr:`~DictationContainerBase.words`.
3233
3334
"""
3435

0 commit comments

Comments
 (0)