Skip to content

Add missing documentation for doc alias #90339

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 28, 2021
Merged

Add missing documentation for doc alias #90339

merged 1 commit into from
Oct 28, 2021

Conversation

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Oct 27, 2021

No description provided.

@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 27, 2021
@rust-highfive
Copy link
Contributor

rust-highfive commented Oct 27, 2021

r? @steveklabnik

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 27, 2021
@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Oct 27, 2021

r? @camelid

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rust-log-analyzer

This comment has been minimized.

Sign in to view
camelid
camelid reviewed Oct 27, 2021
View reviewed changes
Copy link
Member

@camelid camelid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some nits, otherwise looks good.

src/doc/rustdoc/src/the-doc-attribute.md Outdated
Copy link
Member

@camelid camelid Oct 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you open a followup PR to replace this with

Suggested change
### `#[doc(no_inline)]`/`#[doc(inline)]`
### `no_inline` and `inline`

(and #[doc(hidden)] below with hidden) for consistency with the earlier parts of this page? In that PR, you'll also need to edit at least one error message that links to this header; it'd probably also be a good idea to add a link target for the old name, something like <span id="docno_inlinedocinline">.

Copy link
Member Author

@GuillaumeGomez GuillaumeGomez Oct 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.

@camelid camelid added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. A-doc-alias Area: `#[doc(alias)]` and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 27, 2021
@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Oct 28, 2021

Thanks for the review @camelid! I'll send the follow-up PR as well.

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Oct 28, 2021

📌 Commit 47786d3 has been approved by GuillaumeGomez

@bors bors 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 28, 2021
@bors
Copy link
Collaborator

bors commented Oct 28, 2021

⌛ Testing commit 47786d3 with merge f2707fe...

@GuillaumeGomez GuillaumeGomez mentioned this pull request Oct 28, 2021
Merged
@bors
Copy link
Collaborator

bors commented Oct 28, 2021

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing f2707fe to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Oct 28, 2021
@bors bors merged commit f2707fe into rust-lang:master Oct 28, 2021
@rustbot rustbot added this to the 1.58.0 milestone Oct 28, 2021
@GuillaumeGomez GuillaumeGomez deleted the doc-alias-doc branch October 28, 2021 13:08
@rust-timer
Copy link
Collaborator

rust-timer commented Oct 28, 2021

Finished benchmarking commit (f2707fe): comparison url.

Summary: This benchmark run did not return any relevant changes.

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

@rustbot label: -perf-regression

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 30, 2021
@matthiaskrgr
Rollup merge of rust-lang#90374 - GuillaumeGomez:unify-rustdoc-book-t…
e8991e9 
…itles, r=camelid

Unify titles in rustdoc book doc attributes chapter

As discussed in rust-lang#90339.

I wasn't able to find out where the link to the titles was used so let's see if the CI fails. :)

r? `@camelid`
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Oct 30, 2021
@matthiaskrgr
Rollup merge of rust-lang#90374 - GuillaumeGomez:unify-rustdoc-book-t…
a213740 
…itles, r=camelid

Unify titles in rustdoc book doc attributes chapter

As discussed in rust-lang#90339.

I wasn't able to find out where the link to the titles was used so let's see if the CI fails. :)

r? ``@camelid``
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@camelid camelid camelid left review comments

Assignees

@camelid camelid

Labels

A-doc-alias Area: `#[doc(alias)]` A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.58.0

Development

Successfully merging this pull request may close these issues.

8 participants

@GuillaumeGomez @rust-highfive @rust-log-analyzer @bors @rust-timer @camelid @steveklabnik @rustbot