Conversation
proofconstruction
left a comment
There was a problem hiding this comment.
A sorely-needed addition to the project documentation!
These are just some suggestions to improve phrasing/clarity and fix typos.
|
Thanks for the fast reviews @proofconstruction @fricklerhandwerk and @zmitchell, I agree with the suggestions and applied them :) |
lib/README.md
Outdated
There was a problem hiding this comment.
This should be documented at least in the files themselves, but having a copy here is probably good.
There was a problem hiding this comment.
How about just linking to this README from those files to avoid duplicated information?
There was a problem hiding this comment.
I think the loss of convenience due to the indirection outweighs the duplication, because this info doesn't change often.
There was a problem hiding this comment.
I added documentation to each individually testable file now
Co-authored-by: Alexander Groleau <[email protected]> Co-authored-by: Valentin Gagarin <[email protected]> Co-authored-by: Robert Hensing <[email protected]>
|
Awesome, thanks! |
Description of changes
Long overdue. Motivated by trying to document the Nixpkgs structure in #237439, which could benefit from Readme's going into more detail.