From 1e4aaea431a7fb87a54fd3dd9600c8a346744ff2 Mon Sep 17 00:00:00 2001 From: steveklabnik Date: Fri, 11 Aug 2017 16:24:18 -0400 Subject: [PATCH] address review feedback --- src/doc/rustdoc/src/the-doc-attribute.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/doc/rustdoc/src/the-doc-attribute.md b/src/doc/rustdoc/src/the-doc-attribute.md index b77565ec2d7..978d7656bdd 100644 --- a/src/doc/rustdoc/src/the-doc-attribute.md +++ b/src/doc/rustdoc/src/the-doc-attribute.md @@ -46,35 +46,41 @@ These options control how the docs look at a macro level. This form of the `doc` attribute lets you control the favicon of your docs. ```rust,ignore -#![doc(html_favicon_url = "https://foo.com/favicon.ico")] +#![doc(html_favicon_url = "https://example.com/favicon.ico")] ``` This will put `` into your docs, where the string for the attribute goes into the `{}`. +If you don't use this attribute, there will be no favicon. + ### `html_logo_url` This form of the `doc` attribute lets you control the logo in the upper left hand side of the docs. ```rust,ignore -#![doc(html_logo_url = "https://foo.com/logo.jpg")] +#![doc(html_logo_url = "https://example.com/logo.jpg")] ``` This will put `logo` into your docs, where the string for the attribute goes into the `{}`. +If you don't use this attribute, there will be no logo. + ### `html_playground_url` This form of the `doc` attribute lets you control where the "run" buttons on your documentation examples make requests to. ```rust,ignore -#![doc(html_playground_url = "https://playground.foo.com/")] +#![doc(html_playground_url = "https://playground.example.com/")] ``` Now, when you press "run", the button will make a request to this domain. +If you don't use this attribute, there will be no run buttons. + ### `issue_tracker_base_url` This form of the `doc` attribute is mostly only useful for the standard library; @@ -83,7 +89,7 @@ given. `rustdoc` uses this number, plus the base URL given here, to link to the tracking issue. ```rust,ignore -#![doc(issue_tracker_base_url = "https://github.com/foo/foo/issues/")] +#![doc(issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] ``` ### `html_no_source`