JoshOrndorff
kitchen rustdocs
Once the recipes are well-tested and have a nice CI setup,
It would be nice to change // comments to doc comments /// and generate documentation for the modules. The rustdocs might also
- introduce rust-inherited substrate conventions for organizing docs
- discuss the value add of documentation for code (and maybe how it can be deployed?)
- could also cover the process for publishing crates
I've always wondered why I don't see more doc tests, but it makes sense with all the boilerplate required to mock the runtime.
The motivation behind this is that, even with the recipes in mdbook form, the code is difficult to understand upon initially reading it. An example is storage-cache which has the intention of showing that multiple calls to storage are bad, but the contrived examples are convoluted.
The written up recipe has code snippets that are just too long. Either (1) replace with a simpler example or (2) document the logic more explicitly in the code itself and add docs. Both (1) and (2) might be the best option.