Skip to content
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

Add doc-alias documentation #646

Closed
wants to merge 1 commit into from
Closed

Add doc-alias documentation #646

wants to merge 1 commit into from

Conversation

GuillaumeGomez
Copy link
Member

@Centril
Copy link
Contributor

Centril commented Aug 3, 2019

Why is this being added here?

It's both unstable and AFAIK not part of Rust the language. The only part that is part of the language is that the compiler is aware that a doc attribute exists and not what form $tts may take in #[doc($tts)].

@GuillaumeGomez
Copy link
Member Author

It's part of the stabilization process as far as I can tell. Also, it's an attribute so it seems to be at its place or did I miss something?

@Centril
Copy link
Contributor

Centril commented Aug 3, 2019

The reference is meant to specify Rust the language, not rustdoc specific things. I would prefer to just mention that #[doc] exists and then link to some other source, e.g. rustdoc specific documentation.

cc @ehuss

@ehuss
Copy link
Contributor

ehuss commented Aug 3, 2019

Yea, we only briefly mention the doc attribute in https://doc.rust-lang.org/nightly/reference/attributes.html and defer to https://doc.rust-lang.org/rustdoc/the-doc-attribute.html for the actual documentation. It looks like your rustdoc PR already updates that page, so I would say this is not necessary.

@GuillaumeGomez
Copy link
Member Author

Fine by me. Just close the PR if it's your final decision. 😃

@Centril
Copy link
Contributor

Centril commented Aug 3, 2019

Alright; thanks!

@Centril Centril closed this Aug 3, 2019
@GuillaumeGomez GuillaumeGomez deleted the add-doc-alias-doc branch August 4, 2019 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants