Skip to content

Allow ascii whitespace char for doc aliases - #77570

Merged
bors merged 3 commits into
rust-lang:masterfrom
GuillaumeGomez:whitespace-doc-alias
Oct 15, 2020
Merged

Allow ascii whitespace char for doc aliases #77570
bors merged 3 commits into
rust-lang:masterfrom
GuillaumeGomez:whitespace-doc-alias

Conversation

@GuillaumeGomez

@GuillaumeGomezGuillaumeGomez commented Oct 5, 2020

Copy link
Copy Markdown
Member

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 5, 2020
@GuillaumeGomezGuillaumeGomez changed the title Whitespace doc aliasAllow ascii whitespace char for doc aliases Oct 5, 2020
@lopopolo

lopopolo commented Oct 5, 2020

Copy link
Copy Markdown
Contributor

Thank you! 📚

@jyn514jyn514 added A-doc-alias Area: `#[doc(alias)]` T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Oct 5, 2020
@jyn514

jyn514 commented Oct 5, 2020

Copy link
Copy Markdown
Member

You need to run x.py test src/test/rustdoc --test-args check-doc-alias --bless:

---- [ui] ui/check-doc-alias-attr.rs stdout ----
diff of stderr:
36	LL | | ")]
37 | |_^
38 -	error: ' ' character isn't allowed in `#[doc(alias = "...")]`
- --> $DIR/check-doc-alias-attr.rs:14:7
- |
-	LL | #[doc(alias = " ")]
- | ^^^^^^^^^^^
- 45	error: '\t' character isn't allowed in `#[doc(alias = "...")]`
46 --> $DIR/check-doc-alias-attr.rs:15:7
47 |
48	LL | #[doc(alias = "\t")]
49 | ^^^^^^^^^^^^
50 -	error: aborting due to 8 previous errors
+	error: aborting due to 7 previous errors

Other than that this seems fine to me.

@jyn514

jyn514 commented Oct 5, 2020

Copy link
Copy Markdown
Member

Actually ollie had concerns about this in #76705 (comment), so

r? @ollie27

@rust-highfiverust-highfive assigned ollie27 and unassigned jyn514Oct 5, 2020
pickfire
pickfire reviewed Oct 5, 2020
View reviewed changes
Comment threadcompiler/rustc_passes/src/check_attr.rs Outdated
@ollie27

ollie27 commented Oct 5, 2020

Copy link
Copy Markdown
Contributor

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.

@GuillaumeGomez

GuillaumeGomez commented Oct 6, 2020

Copy link
Copy Markdown
MemberAuthor

Excellent point! Then I'll update this PR to take this into account.

@GuillaumeGomez

GuillaumeGomez commented Oct 6, 2020

Copy link
Copy Markdown
MemberAuthor

Updated!

pickfire
pickfire reviewed Oct 6, 2020
View reviewed changes
Comment threadcompiler/rustc_passes/src/check_attr.rs
@GuillaumeGomez

GuillaumeGomez commented Oct 12, 2020

Copy link
Copy Markdown
MemberAuthor

ping @ollie27

@GuillaumeGomez

GuillaumeGomez commented Oct 14, 2020

Copy link
Copy Markdown
MemberAuthor

I fixed the last comments so let's move on!

@bors: r=jyn514,ollie27

@bors

bors commented Oct 14, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit 11f3476 has been approved by jyn514,ollie27

@bors

bors commented Oct 14, 2020

Copy link
Copy Markdown
Collaborator

🌲 The tree is currently closed for pull requests below priority 100, this pull request will be tested once the tree is reopened

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 14, 2020
@JohnTitorJohnTitor mentioned this pull request Oct 14, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Oct 14, 2020
@bors
Auto merge ofrust-lang#77954- JohnTitor:rollup-bpoy497, r=JohnTitor
f42692b
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`
@bors
bors merged commit 35210a6 into rust-lang:masterOct 15, 2020
@rustbotrustbot added this to the 1.49.0 milestone Oct 15, 2020
@GuillaumeGomez
GuillaumeGomez deleted the whitespace-doc-alias branch October 15, 2020 08:21
@ShE3pyShE3py mentioned this pull request Jul 8, 2024
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 9, 2024
@matthiaskrgr
Rollup merge ofrust-lang#127484- ShE3py:rustdoc-doc-alias-whitespac…
5b84462
…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
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 9, 2024
@matthiaskrgr
Rollup merge ofrust-lang#127484- ShE3py:rustdoc-doc-alias-whitespac…
16ed243
…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
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 9, 2024
@matthiaskrgr
Rollup merge ofrust-lang#127484- ShE3py:rustdoc-doc-alias-whitespac…
1df9bfe
…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
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 9, 2024
@matthiaskrgr
Rollup merge ofrust-lang#127484- ShE3py:rustdoc-doc-alias-whitespac…
615f5a3
…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
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 9, 2024
@matthiaskrgr
Rollup merge ofrust-lang#127484- ShE3py:rustdoc-doc-alias-whitespac…
4f39a6f
…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
jhpratt added a commit to jhpratt/rust that referenced this pull request Jul 10, 2024
@jhpratt
Rollup merge ofrust-lang#127484- ShE3py:rustdoc-doc-alias-whitespac…
85bd32c
…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
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jul 10, 2024
@matthiaskrgr
Rollup merge ofrust-lang#127484- ShE3py:rustdoc-doc-alias-whitespac…
f1d4a06
…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
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jul 10, 2024
@rust-timer
Unrolled build forrust-lang#127484
88c274f
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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@pickfirepickfirepickfire left review comments
@jyn514jyn514jyn514 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@ollie27ollie27

Labels

A-doc-aliasArea: `#[doc(alias)]`S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.49.0

Development

Successfully merging this pull request may close these issues.

8 participants

@GuillaumeGomez@lopopolo@jyn514@ollie27@bors@pickfire@rust-highfive@rustbot