diff options
| author | Miran <narimiran@disroot.org> | 2020-09-17 19:55:18 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-17 19:55:18 +0200 |
| commit | cbd78ec1f68e78a88e4a83a5009bc4c8c28c79b3 (patch) | |
| tree | 5940f4e87c6de3f246948af18eee7fa3c85f65b2 /doc/docgen.rst | |
| parent | bc9967f05a4272eb35f543ba6422086b57320ad8 (diff) | |
| download | Nim-cbd78ec1f68e78a88e4a83a5009bc4c8c28c79b3.tar.gz | |
close #6071, remove the mentions of deprecated `docSeeSrcUrl` (#15350)
Diffstat (limited to 'doc/docgen.rst')
| -rw-r--r-- | doc/docgen.rst | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/doc/docgen.rst b/doc/docgen.rst index dac8808ad..636af6574 100644 --- a/doc/docgen.rst +++ b/doc/docgen.rst @@ -209,8 +209,6 @@ file. See source switch ----------------- -The ``docSeeSrcUrl`` switch is deprecated. Use: - :: nim doc2 --git.url:<url> filename.nim @@ -345,9 +343,8 @@ but can have up to four (additional columns are ignored). The content of these columns is: 1. Mandatory term being indexed. Terms can include quoting according to - Nim's rules (eg. \`^\`). -2. Base filename plus anchor hyperlink (eg. - ``algorithm.html#*,int,SortOrder``). + Nim's rules (e.g. \`^\`). +2. Base filename plus anchor hyperlink (e.g. ``algorithm.html#*,int,SortOrder``). 3. Optional human readable string to display as hyperlink. If the value is not present or is the empty string, the hyperlink will be rendered using the term. Prefix whitespace indicates that this entry is |