WIP: Documentation #23
Conversation
- explain macro parameters - Include usage example from the "book" draft
| @@ -49,7 +49,7 @@ where | |||
| } | |||
| } | |||
|
|
|||
| /// Canvas for GPU drawing with Vger. See https://github.com/audulus/vger-rs. | |||
| /// Canvas for GPU drawing with Vger. See <https://github.com/audulus/vger-rs>. | |||
There was a problem hiding this comment.
Where does that warning come from?
There was a problem hiding this comment.
When I ran cargo doc, it threw a warning (https://doc.rust-lang.org/rustdoc/lints.html#bare_urls). Essentially, as it was it wouldn't actually render into a hyperlink, just a URL text. Adding <> should make it a hyperlink.
There was a problem hiding this comment.
I've just compared the version on docs.rs and my local docs build, and adding <> as suggested really did turn this into a hyperlink.
Before the change:
After:
There was a problem hiding this comment.
The warning page I linked to explains why it doesn't show up unless you try and build the docs locally:
Note that, except for
missing_docs, these lints are only available when running rustdoc, not rustc.
There was a problem hiding this comment.
Cool.. thanks for the info!
|
This seems like a good step. Why not just merge it now? |
This is the branch containing my ongoing efforts to help document the library (#10). Please do not merge them yet.
If you have any problems with the docs, please tell me and/or edit the branch.