diff options
| author | Mats Wichmann <mats@linux.com> | 2024-06-28 13:59:45 (GMT) |
|---|---|---|
| committer | Mats Wichmann <mats@linux.com> | 2024-06-28 13:59:45 (GMT) |
| commit | ed81110dd6552839f49e64386a9822413b48de63 (patch) | |
| tree | 1e0b43832f2d50b112e6534bfe0e05722b966d6f /doc/sphinx/index.rst | |
| parent | 3fe014dcb2ff3a8fea3fe844f493ad0635ed6598 (diff) | |
| download | SCons-ed81110dd6552839f49e64386a9822413b48de63.zip SCons-ed81110dd6552839f49e64386a9822413b48de63.tar.gz SCons-ed81110dd6552839f49e64386a9822413b48de63.tar.bz2 | |
Fix markup error in apidocs intro [skip appveyor]
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'doc/sphinx/index.rst')
| -rw-r--r-- | doc/sphinx/index.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index 1bf81d9..1b810eb 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -21,8 +21,9 @@ SCons API Documentation that are inherited, sometimes with no information at all, sometimes with a signature/description that seems mangled: Python upstream has similar limitations as to the quality of dosctrings vs the current - standards Sphinx expects. Inherited interfaces can be identified by the - lack of a ```[source]``` button to the right of the method signature. + standards Sphinx expects. Inherited interfaces from outside SCons + code can be identified by the lack of a ``[source]`` button to the + right of the method signature. If you are looking for the Public API - the interfaces that have long-term consistency guarantees, which you can reliably use when |