From cbd78ec1f68e78a88e4a83a5009bc4c8c28c79b3 Mon Sep 17 00:00:00 2001 From: Miran Date: Thu, 17 Sep 2020 19:55:18 +0200 Subject: [PATCH] close #6071, remove the mentions of deprecated `docSeeSrcUrl` (#15350) --- config/nimdoc.cfg | 4 ++-- doc/docgen.rst | 7 ++----- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg index 3560c0d65d..9a56fdaaef 100644 --- a/config/nimdoc.cfg +++ b/config/nimdoc.cfg @@ -55,13 +55,13 @@ doc.item.toc = """ """ # HTML rendered for doc.item's seeSrc variable. Note that this will render to -# the empty string if you don't pass anything through --docSeeSrcURL. Available +# the empty string if you don't pass anything through --git.url. Available # substitutaion variables here are: # * $commit: branch/commit to use in source link. # * $devel: branch to use in edit link. # * $path: relative path to the file being processed. # * $line: line of the item in the original source file. -# * $url: whatever you did pass through the --docSeeSrcUrl switch (which also +# * $url: whatever you did pass through the --git.url switch (which also # gets variables path/line replaced!) doc.item.seesrc = """   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