File tree 1 file changed +9
-3
lines changed
1 file changed +9
-3
lines changed Original file line number Diff line number Diff line change @@ -146,19 +146,25 @@ The unsafe [`std::ptr::read`] requires the following of the caller.
146
146
<a id =" c-link " ></a >
147
147
## Prose contains hyperlinks to relevant things (C-LINK)
148
148
149
- Links to methods within the same type usually look like this:
149
+ Regular links can be added inline with the usual markdown syntax of
150
+ ` [text](url) ` . Links to other types can be added by marking them with
151
+ `` [`text`] `` , then adding the link target in a new line at the end of
152
+ the docstring with `` [`text`]: <target> `` , where ` <target> ` is
153
+ described below.
154
+
155
+ Link targets to methods within the same type usually look like this:
150
156
151
157
``` md
152
158
[`serialize_struct`]: #method.serialize_struct
153
159
```
154
160
155
- Links to other types usually look like this:
161
+ Link targets to other types usually look like this:
156
162
157
163
``` md
158
164
[`Deserialize`]: trait.Deserialize.html
159
165
```
160
166
161
- Links may also point to a parent or child module:
167
+ Link targets may also point to a parent or child module:
162
168
163
169
``` md
164
170
[`Value`]: ../enum.Value.html
You can’t perform that action at this time.
0 commit comments