Pile of rustdoc fixes #13914
Closed
Pile of rustdoc fixes #13914
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These fonts were moved into place by rust's makefiles, but rustdoc is widely used outside of rustc itself. This moves the fonts into the rustdoc binary, similarly to the other static assets, and writes them to the output location whenever rustdoc generates documentation. Closes rust-lang#13593 Closes rust-lang#13787
They're much more useful when building code, much less so when building documentation. Closes rust-lang#13894
This is mostly just an artificial requirement as it can use similar logic to the compiler to infer the crate id.
This makes them a little easier to search for and makes it clearer that they're a macro and not an item to import. Closes rust-lang#13852
The outer attributes were manually appended when a module file was parsed, but the attributes were also added higher up the stack of parsing (when the module finished parsing). This removes the append in parsing the module file. Closes rust-lang#13826
Previously, if an initializer took multiple lines or was just large in general, it was pretty poorly rendered [1] [2]. This alters the logic to just link back to the source for any multi-line static, with a placeholder of "[definition]". This should make reading statics a little easier on the eyes. All single-line statics are still inlined in the documentation. Closes rust-lang#13198 [1] - http://static.rust-lang.org/doc/master/sync/mutex/index.html#statics [2] - http://static.rust-lang.org/doc/master/std/sync/atomics/index.html#statics
Rustdoc currently doesn't inline documentation of a `pub use` if the target is publicly reachable. This changes rustdoc to allow a #[doc(inline)] attribute to force inlining the documentation, regardless of whether the targe is public or not. Closes rust-lang#13045
This allows writing code examples which pass all analysis of the compiler, but
don't actually link. A good example is examples that use extern {} blocks.
Closes rust-lang#12903
|
I think that the failure is due to line 1411 of tutorial where code block begins with 3 tildes and ends with 4. |
This primary fix brought on by this upgrade is the proper matching of the ``` and ~~~ doc blocks. This also moves hoedown to a git submodule rather than a bundled repository. Additionally, hoedown is stricter about code blocks, so this ended up fixing a lot of invalid code blocks (ending with " ```" instead of "```", or ending with "~~~~" instead of "~~~"). Closes rust-lang#12776
This enables hoedown's footnote extension, and fixes all footnotes in the reference manual to use the new syntax.
This hasn't worked since pandoc stopped being used. We can get by well enough with the superscript extension for these equations. Closes rust-lang#12989
This commit removes the inherited documentation from type pages. This generally just clutters up the page when you can click through to the trait itself to get all the meaty documentation. Closes rust-lang#11991
bors
added a commit
that referenced
this pull request
May 7, 2014
Lots of assorted things here and there, all the details are in the commits. Closes #11712
| @@ -135,7 +135,7 @@ For simplicity, we do not plan to do so. Implementing automatic semicolon insert | |||
|
|
|||
| **Short answer** set the RUST_LOG environment variable to the name of your source file, sans extension. | |||
|
|
|||
| ``` {.sh .notrust} | |||
| ```notrust,sh | |||
There was a problem hiding this comment.
Does the {...} syntax no longer work?
There was a problem hiding this comment.
I was having some trouble, but I have to admit that I didn't investigate it thoroughly. I'll take a look into this later today.
There was a problem hiding this comment.
With some testing, it appears that hoedown doesn't like anything with a space in it.
There was a problem hiding this comment.
(it doesn't segfault, it appears to just ignore it)
There was a problem hiding this comment.
This notation is less verbose anyway.
arcnmx
pushed a commit
to arcnmx/rust
that referenced
this pull request
Jan 9, 2023
…ite, r=lnicola minor: Make `qualify_method_call` `RefactorRewrite` See rust-lang/rust-analyzer#13825 (comment)
flip1995
pushed a commit
to flip1995/rust
that referenced
this pull request
Jan 9, 2025
`asked to assemble constituent types of unexpected type: Binder(Foo, [])` Fixes rust-lang#10972 changelog: none
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Lots of assorted things here and there, all the details are in the commits.
Closes #11712