-
Notifications
You must be signed in to change notification settings - Fork 12.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow ascii whitespace char for doc aliases #77570
Conversation
Thank you! 📚 |
You need to run
Other than that this seems fine to me. |
Actually ollie had concerns about this in #76705 (comment), so r? @ollie27 |
b78410c
to
aebb966
Compare
aebb966
to
accc26a
Compare
The issue I had with whitespace is that search queries are trimmed so if an alias begins with or ends in whitespace then it's impossible to search for it. We could allow spaces as long as they're not at the beginning or end of the alias though. |
Excellent point! Then I'll update this PR to take this into account. |
Updated! |
ping @ollie27 |
I fixed the last comments so let's move on! @bors: r=jyn514,ollie27 |
📌 Commit 11f3476 has been approved by |
🌲 The tree is currently closed for pull requests below priority 100, this pull request will be tested once the tree is reopened |
Rollup of 9 pull requests Successful merges: - rust-lang#77570 (Allow ascii whitespace char for doc aliases ) - rust-lang#77739 (Remove unused code) - rust-lang#77753 (Check html comments) - rust-lang#77879 (Provide better documentation and help messages for x.py setup) - rust-lang#77902 (Include aarch64-pc-windows-msvc in the dist manifests) - rust-lang#77934 (Document -Z codegen-backend in the unstable book) - rust-lang#77936 (Remove needless alloc_slice) - rust-lang#77946 (Validate references to source scopes) - rust-lang#77951 (Update books) Failed merges: r? `@ghost`
…e-doc, r=fmease `#[doc(alias)]`'s doc: say that ASCII spaces are allowed PR rust-lang#77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so. The code checking the aliases: https://github.com/rust-lang/rust/blob/7fdefb804ec300fb605039522a7c0dfc9e7dc366/compiler/rustc_passes/src/check_attr.rs#L693-L704 `@rustbot` label +A-docs
…e-doc, r=fmease `#[doc(alias)]`'s doc: say that ASCII spaces are allowed PR rust-lang#77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so. The code checking the aliases: https://github.com/rust-lang/rust/blob/7fdefb804ec300fb605039522a7c0dfc9e7dc366/compiler/rustc_passes/src/check_attr.rs#L693-L704 ``@rustbot`` label +A-docs
…e-doc, r=fmease `#[doc(alias)]`'s doc: say that ASCII spaces are allowed PR rust-lang#77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so. The code checking the aliases: https://github.com/rust-lang/rust/blob/7fdefb804ec300fb605039522a7c0dfc9e7dc366/compiler/rustc_passes/src/check_attr.rs#L693-L704 ```@rustbot``` label +A-docs
…e-doc, r=fmease `#[doc(alias)]`'s doc: say that ASCII spaces are allowed PR rust-lang#77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so. The code checking the aliases: https://github.com/rust-lang/rust/blob/7fdefb804ec300fb605039522a7c0dfc9e7dc366/compiler/rustc_passes/src/check_attr.rs#L693-L704 ````@rustbot```` label +A-docs
…e-doc, r=fmease `#[doc(alias)]`'s doc: say that ASCII spaces are allowed PR rust-lang#77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so. The code checking the aliases: https://github.com/rust-lang/rust/blob/7fdefb804ec300fb605039522a7c0dfc9e7dc366/compiler/rustc_passes/src/check_attr.rs#L693-L704 `````@rustbot````` label +A-docs
…e-doc, r=fmease `#[doc(alias)]`'s doc: say that ASCII spaces are allowed PR rust-lang#77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so. The code checking the aliases: https://github.com/rust-lang/rust/blob/7fdefb804ec300fb605039522a7c0dfc9e7dc366/compiler/rustc_passes/src/check_attr.rs#L693-L704 ``````@rustbot`````` label +A-docs
…e-doc, r=fmease `#[doc(alias)]`'s doc: say that ASCII spaces are allowed PR rust-lang#77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so. The code checking the aliases: https://github.com/rust-lang/rust/blob/7fdefb804ec300fb605039522a7c0dfc9e7dc366/compiler/rustc_passes/src/check_attr.rs#L693-L704 ```````@rustbot``````` label +A-docs
Rollup merge of rust-lang#127484 - ShE3py:rustdoc-doc-alias-whitespace-doc, r=fmease `#[doc(alias)]`'s doc: say that ASCII spaces are allowed PR rust-lang#77570 allowed ASCII spaces in doc aliases, but the documentation wasn't updated to say so. The code checking the aliases: https://github.com/rust-lang/rust/blob/7fdefb804ec300fb605039522a7c0dfc9e7dc366/compiler/rustc_passes/src/check_attr.rs#L693-L704 ``````@rustbot`````` label +A-docs
Fixes issue from #76705 (comment)
cc @lopopolo @ollie27
r? @jyn514