Add link to rustdoc book search chapter in help popover #112740
Merged
Conversation
This file contains 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
rustbot
added
S-waiting-on-review
|
Some changes occurred in HTML/CSS/JS. cc @GuillaumeGomez, @Folyd, @jsha |
notriddle
reviewed
Jun 17, 2023
| @@ -1068,6 +1068,9 @@ function preLoadCss(cssUrl) { | |||
| div_shortcuts.innerHTML = "<h2>Keyboard Shortcuts</h2><dl>" + shortcuts + "</dl></div>"; | |||
|
|
|||
| const infos = [ | |||
| "For a full list of all search features, take a look <a \ | |||
| href='https://doc.rust-lang.org/stable/rustdoc/how-to-read-rustdoc.html\ | |||
There was a problem hiding this comment.
Maybe we should be passing DOC_RUST_LANG_ORG_CHANNEL through here instead (as well as line 1051)? Probably use getVar to link to it.
GuillaumeGomez
force-pushed
the
link-to-search-chapter
branch
from
06cabcf to
861c2b8
Compare
GuillaumeGomez
commented
Jun 23, 2023
| @@ -582,6 +583,8 @@ pub(crate) fn has_doc_flag(tcx: TyCtxt<'_>, did: DefId, flag: Symbol) -> bool { | |||
| /// | |||
| /// Set by `bootstrap::Builder::doc_rust_lang_org_channel` in order to keep tests passing on beta/stable. | |||
| pub(crate) const DOC_RUST_LANG_ORG_CHANNEL: &str = env!("DOC_RUST_LANG_ORG_CHANNEL"); | |||
| pub(crate) static DOC_CHANNEL: Lazy<&'static str> = | |||
There was a problem hiding this comment.
DOC_RUST_LANG_ORG_CHANNEL contains the full URL to the doc. It's not a problem in itself but since it's stored in all generated pages, better to just keep the channel, hence why I stored it this way.
|
Applied your suggestion. |
notriddle
requested changes
Jun 23, 2023
GuillaumeGomez
force-pushed
the
link-to-search-chapter
branch
from
861c2b8 to
2f1939a
Compare
|
Updated! |
|
r=me when CI passes |
|
@bors r=notriddle rollup |
bors
added
S-waiting-on-bors
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Jun 23, 2023
…ter, r=notriddle Add link to rustdoc book search chapter in help popover One thing that was missing in the rustdoc output and its help popover was a link back to the search feature chapter in the rustdoc book. It looks like this:  r? `@notriddle`
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jun 23, 2023
…ter, r=notriddle Add link to rustdoc book search chapter in help popover One thing that was missing in the rustdoc output and its help popover was a link back to the search feature chapter in the rustdoc book. It looks like this:  r? ``@notriddle``
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Jun 23, 2023
…ter, r=notriddle Add link to rustdoc book search chapter in help popover One thing that was missing in the rustdoc output and its help popover was a link back to the search feature chapter in the rustdoc book. It looks like this:  r? ```@notriddle```
bors
added
S-waiting-on-author
|
Fixed the GUI test. Since a GUI failure isn't caught in the CI currently, let's r+ it. @bors r=notriddle rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jun 23, 2023
…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#112616 (Improve tests on targets without unwinding) - rust-lang#112643 (Always register sized obligation for argument) - rust-lang#112740 (Add link to rustdoc book search chapter in help popover) - rust-lang#112810 (Don't ICE on unnormalized struct tail in layout computation) - rust-lang#112870 (Migrate `item_bounds` to `ty::Clause`) - rust-lang#112925 (Stop hiding const eval limit in external macros) - rust-lang#112960 ([tests/rustdoc] Add `@files` command) - rust-lang#112962 (Fix rustdoc gui tester) r? `@ghost` `@rustbot` modify labels: rollup
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.
One thing that was missing in the rustdoc output and its help popover was a link back to the search feature chapter in the rustdoc book.
It looks like this:
r? @notriddle