Might be a wee bit of slagging on the way to Scottish fluency as well!
I’ve got the family plaid. I guess I really should start picking up the lingo!
cargo doc
builds the documentation in target\doc\<crate_name>\index.html
; currently parts are still under documented but it is progressing nicely
@BenMS Yes, I’ve seen that but not used the local docs much - do they differ from the online language and library refs?
Also, If any of you have tried the SolidOak Rust IDE and think its worth giving a go let me know. I tried but couldn’t get some library it wants to build so gave up.
No the nice thing is these produce exactly the same docs as library refs. So when you get used to it all libs are documented the same way. I find myself reaching there now instead of reading source code, a very nice feature. This week we are switching on deny(missing_docs)
to ensure all public API’s are documented for anyone who wants to know the lib capabilities and interfaces. A really cool thing to have this conformity across a code base. If you click on the API documentation link of our libs you will see they are all the same and includes the API docs for any included libs we use as well. So all the way to the metal
[edit I hope everyone realises when I say our I mean our as in this communities]