Skip to content

Add more explanatory text to the C-LINK section #220

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

Merged
merged 1 commit into from
Dec 22, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,19 +146,25 @@ The unsafe [`std::ptr::read`] requires the following of the caller.
<a id="c-link"></a>
## Prose contains hyperlinks to relevant things (C-LINK)

Links to methods within the same type usually look like this:
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
```

Links to other types usually look like this:
Link targets to other types usually look like this:

```md
[`Deserialize`]: trait.Deserialize.html
```

Links may also point to a parent or child module:
Link targets may also point to a parent or child module:

```md
[`Value`]: ../enum.Value.html
Expand Down