Skip to content

Extend intra-doc links documentation #74436

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed

Conversation

GuillaumeGomez
Copy link
Member

Part of #62834 and of #43466.

r? @Manishearth

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 17, 2020
@Manishearth
Copy link
Member

I think the wording here could use a lot of work: "It's very useful in case you want to..." doesn't sound right for documentation. Furthermore, I feel like the main use case for this feature is to link to doc sections, like https://doc.rust-lang.org/stable/std/fmt/index.html#positional-parameters , as opposed to linking to specific impls.

@Manishearth
Copy link
Member

Do you mind if I write some documentation on this and include it in #74430 ?

@GuillaumeGomez
Copy link
Member Author

No I don't mind, go ahead! Please close this PR once done.

Also, I remember that @jyn514 had some ideas of improvement for the documentation. You might want to talk with them as well. :)

@Manishearth
Copy link
Member

Rolled text for this into #74430

@GuillaumeGomez GuillaumeGomez deleted the intra-doc-anchor branch July 17, 2020 20:17
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants