Skip to content

Commit f08b390

Browse files
committed
Update documentation (#69)
1 parent 6cc4419 commit f08b390

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/src/about.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Caveats
2929

3030
- Only simple assignments of names, attributes and calls to a single name
3131
are tracked and used to resolve later values.
32-
- Only simple return type hints that consists of a single resolved type
33-
(not a string) are tracked through call and attribute access chains.
32+
- Only simple return type hints that consist of a single, possibly optional
33+
type are tracked through call and attribute access chains.
3434
- Type hints of intersphinx-linked definitions are not necessarily available.
3535
Resolving names using type hints is only possible if the package is
3636
installed, but simple usage can be tracked via documentation entries alone.
@@ -55,6 +55,14 @@ It shouldn't become outdated, but a clean build can be achieved with
5555
`sphinx-build -E <https://www.sphinx-doc.org/en/master/man/sphinx-build.html
5656
#cmdoption-sphinx-build-E>`_ or by deleting the build directory.
5757

58+
Copying code blocks
59+
-------------------
60+
If you feel like code links make copying code a bit more difficult,
61+
`sphinx-copybutton <https://sphinx-copybutton.readthedocs.io>`_
62+
is a fantastic extension to use.
63+
It adds a button to copy an entire code block to the clipboard.
64+
So give it a go, perhaps even if you don't think links make copying harder!
65+
5866
Matching failures
5967
-----------------
6068
Matching can fail on two levels, for a whole code example or a specific line.

0 commit comments

Comments
 (0)