about summary refs log tree commit diff
path: root/src/doc/rustdoc
AgeCommit message (Collapse)AuthorLines
2021-01-10Fix relative linksJoshua Nelson-8/+8
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-10Fix typoJoshua Nelson-1/+1
Co-authored-by: Camelid <camelidcamel@gmail.com>
2021-01-10Address review commentsJoshua Nelson-25/+41
- Improve wording - Use relative links - Use a proper list instead of a wall of text - Improve examples
2021-01-10Document differences from markdownJoshua Nelson-0/+3
2021-01-10Update intra-doc link documentation to match the implementationJoshua Nelson-8/+56
2020-12-28Rollup merge of #80410 - MarcoIeni:patch-1, r=jonas-schievinkMara Bos-1/+1
rustdoc book: fix example `lib.rs` file is created only if `--lib` flag is specified
2020-12-28Rollup merge of #80393 - ehuss:doc-git-link, r=jyn514Mara Bos-0/+3
Add links to the source for the rustc and rustdoc books. This adds a little icon in the upper-right corner of the books so that readers can find the source if they want to make changes or file issues. This is already included in several of the other books.
2020-12-27rustdoc book: fix exampleMarco Ieni-1/+1
2020-12-26Add links to the source for the rustc and rustdoc books.Eric Huss-0/+3
2020-12-03fix typo in src/doc/rustdoc/src/command-line-arguments.mdIan Jackson-1/+1
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
2020-12-03rustdoc: document --default-theme option in command line docIan Jackson-0/+20
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
2020-11-06Auto merge of #75778 - AndyGauge:75521-rustdoc-book-improvements, r=jyn514bors-31/+282
75521 rustdoc book improvements Added some guidelines about documenting with rustdoc Fixes #75521
2020-11-05Rename lint to non_autolinksGuillaume Gomez-2/+2
2020-11-05Update URLs used in the lint exampleGuillaume Gomez-14/+15
2020-11-05Rename automatic_links to url_improvementsGuillaume Gomez-1/+1
2020-11-05Improve automatic_links globallyGuillaume Gomez-10/+3
2020-11-05Extend automatic_links lint to take into account URLs without link syntaxGuillaume Gomez-9/+13
2020-11-05Add documentation for automatic_links lintGuillaume Gomez-0/+40
2020-11-04Added Rustdoc book sections for linting and embedding more examplesAndrew Gauger-31/+282
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-28Fix typo "compiltest"Guillaume Gomez-1/+1
2020-10-21Clean up and improve some docsCamelid-13/+15
* compiler docs * Don't format list as part of a code block * Clean up some other formatting * rustdoc book * Update CommonMark spec version to latest (0.28 -> 0.29) * Clean up some various wording and formatting
2020-10-09Link to GitHub issue re macro resolutionCamelid-1/+3
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-10-08Update rustdoc intra-doc link docsCamelid-13/+40
* Describe generic parameters feature * Make general improvements to the docs
2020-10-07Auto merge of #77119 - GuillaumeGomez:unclosed-html-tag-lint, r=jyn514bors-0/+35
Unclosed html tag lint Part of #67799. I think `@ollie27` will be interested (`@Manishearth` too since they opened the issue ;) ). r? `@jyn514`
2020-10-06Rollup merge of #76855 - jyn514:platform-specific, r=ollie27Yuki Okushi-21/+50
Revamp rustdoc docs about documentation using `cfg` - Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from #76849 - Mention that `doc(cfg)` is also for features Addresses https://github.com/rust-lang/rust/pull/76849#issuecomment-694516199. Obsoletes https://github.com/rust-lang/rust/pull/76849 (I made sure to fix the weird dashes too). r? @steveklabnik
2020-10-05Revamp rustdoc docs about documentation using `cfg`Joshua Nelson-21/+50
- Move `cfg(doc)` out of `unstable-features`. It's not unstable. - Remove outdated reference to `everybody_loops`. - Improve wording in various places - Give an example of code this allows (and does not allow) - Link to `cfg(doc)` in `doc(cfg)` documentation. Since one is stable and the other is not, don't combine them. - Cleanup wording for `doc(cfg)` - Incorporate changes from #76849 - Mention that `doc(cfg)` is also for features
2020-10-03Make invalid_html_tags lint only run on nightly and being allowed by defaultGuillaume Gomez-2/+4
2020-10-03Add doc for invalid_html_tag lintGuillaume Gomez-0/+33
2020-10-02Rollup merge of #76811 - GuillaumeGomez:doc-alias-name-restriction, ↵Jonas Schievink-0/+2
r=oli-obk,ollie27 Doc alias name restriction Fixes #76705.
2020-10-02Update doc alias documentationGuillaume Gomez-0/+2
2020-09-27Add documentation for `private_intra_doc_links`Joshua Nelson-0/+40
2020-09-24Auto merge of #74430 - Manishearth:stabilize-intra-doc, r=Manishearthbors-61/+105
Stabilize intra-doc links Fixes https://github.com/rust-lang/rust/issues/43466 Thanks to the great work of `@jyn514` in getting the [cross-crate reexport issue](https://github.com/rust-lang/rust/issues/65983) in intra-rustdoc links fixed, I think we're now in a position to stabilize this feature. The tracking issue currently has two unresolved issues: - <s>behavior around doc(hidden): This is fixed in https://github.com/rust-lang/rust/pull/73365, which is just waiting for CI and should land tomorrow. It's also a pretty niche bug so while I expect it to land soon I don't think we need to block stabilization on it anyway.</s> - Non-identifier primitive types like slices: This was not a part of the original RFC anyway, and is a pretty niche use case The feature itself, sans https://github.com/rust-lang/rust/issues/65983, has been shipped on nightly for three years now, with people using it on docs.rs. https://github.com/rust-lang/rust/issues/65983 itself is not an overwhelmingly central bit of functionality; the reason we elected to block stabilization on it was that back in 2017 it was not possible to fix the issue without some major refactorings of resolve, and we did not want to stabilize something that had such a potentially unfixable bug. Given that we've fixed it, I see no reason to delay stabilization on this long awaited feature. It's possible that the latest patches have problems, however we _have_ done crater runs of some of the crucial parts. Furthermore, that's what the release trains are for, we will have a solid three months to let it ride the trains before it actually hits the stable compiler. r? `@rust-lang/rustdoc`
2020-09-17Update src/doc/rustdoc/src/linking-to-items-by-name.mdManish Goregaokar-1/+1
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-14Update src/doc/rustdoc/src/lints.mdManish Goregaokar-2/+2
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-14Stabilize doc_alias featureGuillaume Gomez-16/+14
2020-09-13Fix lint name in docsManish Goregaokar-1/+1
2020-09-13Resolve some conflictsManish Goregaokar-1/+1
2020-09-13Update src/doc/rustdoc/src/linking-to-items-by-name.mdManish Goregaokar-1/+1
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-13Update src/doc/rustdoc/src/linking-to-items-by-name.mdManish Goregaokar-1/+1
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
2020-09-13Fill out docs on intra-doc resolution failure lintManish Goregaokar-4/+39
2020-09-13Mention URL fragmentsManish Goregaokar-0/+9
2020-09-13Mention super/crate/self in docsManish Goregaokar-1/+1
2020-09-13Move intra-doc-links documentation out of unstable sectionManish Goregaokar-57/+57
2020-09-13Link rustdoc lint docs to the rustdoc book.Eric Huss-0/+58
2020-09-10Add docs about crate level documentation supportarijit79-0/+23
2020-09-01Document lint missing_doc_code_examples is nightly-onlyJes Bak Hansen-1/+1
2020-08-23Document prim@ and primitive@Joshua Nelson-1/+1
2020-08-21Improve wordingGuillaume Gomez-1/+1
2020-08-20Add documentation for --show-coverage optionGuillaume Gomez-0/+33
2020-07-30intra_doc_resolution_failures -> broken_intra_doc_linksManish Goregaokar-1/+1
generated by cgit-pink 1.4.1-3-g733a5 (git 2.37.1) at 2026-02-27 04:54:07 +0000