summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorringabout <43030857+ringabout@users.noreply.github.com>2023-02-01 15:13:40 +0800
committerGitHub <noreply@github.com>2023-02-01 08:13:40 +0100
commitff8ab06720976f18d75257a22bf8e23873514c67 (patch)
treea4719ab7baf2aadd4c90e189bbfba4e1a116fc5d /doc
parentcbf3ed9d92b32e9e28f1e4d52300d9b103ee6fa1 (diff)
downloadNim-ff8ab06720976f18d75257a22bf8e23873514c67.tar.gz
fixes #19396; Nimdoc hide nonexported fields (#21305)
* suppresses non-exported fields of types and adds command-line option to re-enable this if desired

* corrected the doctest that produced a CI error

* an embarrassingly bad error in reasoning

* modified a nimdoc test to reflect updated behavior

* needed another change to bring utils.html doctest in sync with update

* add info

* fix nimdoc

* lint

* render postfix

* fixes a problem

* fixes nimdoc

* fix nimdoc

---------

Co-authored-by: johnperry-math <john.perry@usm.edu>
Co-authored-by: johnperry-math <devotus@yahoo.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/docgen.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/docgen.md b/doc/docgen.md
index 70b41f17d..9e0a83bab 100644
--- a/doc/docgen.md
+++ b/doc/docgen.md
@@ -44,6 +44,7 @@ Generate HTML documentation for a whole project:
   # or `$nimcache/htmldocs` with `--usenimcache` which avoids clobbering your sources;
   # and likewise without `--project`.
   # Adding `-r` will open in a browser directly.
+  # Use `--showNonExports` to show non-exported fields of an exported type.
   ```
 
 Documentation Comments