Skip to content

"interactive" tutorial that describes how to read rustdoc-generated documentation

Notifications You must be signed in to change notification settings

QuietMisdreavus/rustdoc-tutorial

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Rustdoc Field Guide

an "interactive" tutorial to demonstrate how to read rustdoc-generated documentation

most recent rendering

There are a lot of little tricks in rustdoc that people often don't know. There's a "How to read this documentation" in the std docs, but it's easy to overlook and doesn't explain everything in the rustdoc layout. So i'm taking it upon myself to write a guide that's as exhaustive as i can muster, so we can document even more things that rustdoc does.

About

"interactive" tutorial that describes how to read rustdoc-generated documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages