Skip to content

Comments

Create a Readme in lib#244044

Merged
roberth merged 2 commits intoNixOS:masterfrom
tweag:lib-readme
Jul 19, 2023
Merged

Create a Readme in lib#244044
roberth merged 2 commits intoNixOS:masterfrom
tweag:lib-readme

Conversation

@infinisil
Copy link
Member

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.

@infinisil infinisil requested review from a team, fricklerhandwerk and roberth July 17, 2023 20:28
@infinisil infinisil requested a review from edolstra as a code owner July 17, 2023 20:28
@github-actions github-actions bot added the 6.topic: lib The Nixpkgs function library label Jul 17, 2023
Copy link
Contributor

@proofconstruction proofconstruction left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A sorely-needed addition to the project documentation!

These are just some suggestions to improve phrasing/clarity and fix typos.

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Jul 17, 2023
Copy link
Contributor

@fricklerhandwerk fricklerhandwerk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff!

@infinisil
Copy link
Member Author

Thanks for the fast reviews @proofconstruction @fricklerhandwerk and @zmitchell, I agree with the suggestions and applied them :)

lib/README.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be documented at least in the files themselves, but having a copy here is probably good.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about just linking to this README from those files to avoid duplicated information?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the loss of convenience due to the indirection outweighs the duplication, because this info doesn't change often.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added documentation to each individually testable file now

@github-actions github-actions bot added the 6.topic: module system About "NixOS" module system internals label Jul 18, 2023
infinisil and others added 2 commits July 18, 2023 17:22
Co-authored-by: Alexander Groleau <[email protected]>
Co-authored-by: Valentin Gagarin <[email protected]>
Co-authored-by: Robert Hensing <[email protected]>
@roberth roberth merged commit 0665253 into NixOS:master Jul 19, 2023
@roberth
Copy link
Member

roberth commented Jul 19, 2023

Awesome, thanks!

@infinisil infinisil deleted the lib-readme branch July 19, 2023 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.topic: lib The Nixpkgs function library 6.topic: module system About "NixOS" module system internals 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants