about summary refs log tree commit diff
diff options
context:
space:
mode:
authorCamelid <camelidcamel@gmail.com>2021-01-28 15:51:54 -0800
committerCamelid <camelidcamel@gmail.com>2021-01-31 19:22:37 -0800
commit82010e86d388f2250e98cb8859fa272d294ae3b5 (patch)
tree6ba711af1f77094a65df49cfc2fc7bbfb5f0906c
parentbf193d69fe48f4ec3cac57ab7abb4e9f2a291661 (diff)
downloadrust-82010e86d388f2250e98cb8859fa272d294ae3b5.tar.gz
rust-82010e86d388f2250e98cb8859fa272d294ae3b5.zip
rustdoc: Note why `rustdoc::html::markdown` is public
Almost all of the modules are crate-private, except for
`rustdoc::json::types`, which I believe is intended to be for public
use; and `rustdoc::html::markdown`, which is used externally by the
error-index generator and so has to be public.
-rw-r--r--src/librustdoc/html/mod.rs1
-rw-r--r--src/librustdoc/lib.rs3
2 files changed, 3 insertions, 1 deletions
diff --git a/src/librustdoc/html/mod.rs b/src/librustdoc/html/mod.rs
index 403a9303c3f..4318be898ce 100644
--- a/src/librustdoc/html/mod.rs
+++ b/src/librustdoc/html/mod.rs
@@ -2,6 +2,7 @@ crate mod escape;
 crate mod format;
 crate mod highlight;
 crate mod layout;
+// used by the error-index generator, so it needs to be public
 pub mod markdown;
 crate mod render;
 crate mod sources;
diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs
index c61cbf78f77..53f891251f5 100644
--- a/src/librustdoc/lib.rs
+++ b/src/librustdoc/lib.rs
@@ -83,7 +83,8 @@ mod doctree;
 mod error;
 mod doctest;
 mod fold;
-crate mod formats;
+mod formats;
+// used by the error-index generator, so it needs to be public
 pub mod html;
 mod json;
 mod markdown;