Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

nixpkgs: Start documenting library functions in XML #47837

Merged
merged 1 commit into from Oct 5, 2018
Merged

nixpkgs: Start documenting library functions in XML #47837

merged 1 commit into from Oct 5, 2018

Conversation

grahamc
Copy link
Member

@grahamc grahamc commented Oct 4, 2018

Covers assert functions and about half of the attrsets functions.

Some internal consistency around IDs could be improved.

I considered trying to just get them all done first and then PR, but I'm thinking it would be better to get some merged and released now, and then over time we can add more. For example, I could document one function each morning.

Demo: http://gsc.io/nixpkgs-docs/html/#sec-functions-library

Obviously I'd like to backport this.

@grahamc grahamc changed the title nixpkgs: Start documenting library funtions in XML nixpkgs: Start documenting library functions in XML Oct 4, 2018
@Mic92
Copy link
Member

Mic92 commented Oct 4, 2018 •
edited

Reviewers of pull requests in lib should then also make sure that the corresponding documentation gets updated, when something changes.

cc @Profpatsch

@grahamc
Copy link
Member Author

grahamc commented Oct 4, 2018

@Mic92 what do you think the best way to do that is?

Maybe ofborg could learn how to do that, or functions which are already documented could have a line in their comment about updating corresponding docs in $filename...?

@Mic92
Copy link
Member

Mic92 commented Oct 4, 2018 •
edited

@grahamc someone who gets pinged in nixpkgs/.github/CODEOWNERS for lib could do ask for this. I think it is not too much to ask to also not-yet documented functions to doc as they are modified. There is already documentation available that just needs to be copied over. Adding this to ofborg might be not worth yet since we do not change many things in the standard library.

@grahamc
nixpkgs: Start documenting library functions in XML
f835f77 
Covers assert functions and about half of the attrsets functions.

Some internal consistency around IDs could be improved.
@grahamc grahamc merged commit 730dac1 into NixOS:master Oct 5, 2018
@grahamc grahamc deleted the doc-lib-funcs branch October 5, 2018 14:18
@grahamc
Copy link
Member Author

grahamc commented Oct 5, 2018

Backported in 131cb30

@grahamc grahamc restored the doc-lib-funcs branch October 5, 2018 15:10
@grahamc grahamc deleted the doc-lib-funcs branch October 12, 2018 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
8.has: documentation 10.rebuild-darwin: 0 10.rebuild-linux: 0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@grahamc @Mic92 @GrahamcOfBorg