Skip to content

C-LINK should encourage use of intra-rustdoc links over manual linking #241

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

Open
ilyvion opened this issue May 22, 2021 · 0 comments
Open

Comments

@ilyvion
Copy link
Contributor

ilyvion commented May 22, 2021

Since rust-lang/rust#43466 (intra-rustdoc links) was stabilized in Rust 1.48, the information in C-LINK feels outdated, as it still suggests linking to other items manually rather than by making use of intra-rustdoc links:

## Prose contains hyperlinks to relevant things (C-LINK)
Regular links can be added inline with the usual markdown syntax of
`[text](url)`. Links to other types can be added by marking them with
``[`text`]``, then adding the link target in a new line at the end of
the docstring with ``[`text`]: <target>``, where `<target>` is
described below.
Link targets to methods within the same type usually look like this:
```md
[`serialize_struct`]: #method.serialize_struct
```
Link targets to other types usually look like this:
```md
[`Deserialize`]: trait.Deserialize.html
```
Link targets may also point to a parent or child module:
```md
[`Value`]: ../enum.Value.html
[`DeserializeOwned`]: de/trait.DeserializeOwned.html
```

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant