FAQ / Known limitations / Known issues¶
You may also take a look at the same section for rstcheck-core.
There are inherent limitations to what
rstcheck can and cannot do. The reason for this is that
rstcheck itself relies on external tools for parsing and error reporting.
The rst source e.g. is given to
docutils which then parses it and returns the errors.
Therefore rstcheck is more like an error accumulation tool. The same goes for the source
code in supported code blocks.
Windows support is not stable!
Reason: Tests are failing with wrong positives and wrong negatives out of unknown reasons. See issue #107.
ImportError: cannot import name ‘get_terminal_size’ from ‘click.termui’¶
Affected rstcheck version(s): All 6.0 releases
This issue is caused by an incompatibility of the dependency
typer in version
0.4.0 and its
click with version
The issue was fixed in
If you encounter this issue you can either:
rstcheckto a non affected version.
click’s upper version-bound to
<8.1if you need to rely on
typer’s lower version-bound to
typer’s upper version-bound to
<0.4which results in
See #138 for reference.