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

API docs #7814

Closed
Ericson2314 opened this issue Feb 12, 2023 · 4 comments · Fixed by #7896
Closed

API docs #7814

Ericson2314 opened this issue Feb 12, 2023 · 4 comments · Fixed by #7896
Labels
documentation

Comments

@Ericson2314
Copy link
Member

It would be good for have API docs generated from comments in the C++ source.

Even though the internal Nix library APIs are unstable and therefore not intended for large scale outside consumption, contributers to Nix itself would still benefit.

Also, in conjunction with stable bindings to other languages, we've discussed stabilizing parts of the C++ interfaces. This would naturally be good for that.
@Ericson2314 Ericson2314 mentioned this issue Feb 12, 2023
Merged
7 tasks
@roberth
Copy link
Member

roberth commented Feb 13, 2023

Managing expectations around these docs is going to be key. A lot of what they document is internal and subject to change, but that does not mean that we shouldn't improve their documentation.

@edolstra edolstra moved this to 🏗 To discuss in Nix team Feb 17, 2023
@fricklerhandwerk
Copy link
Contributor

Triaged in the Nix team meeting 2023-02-17:

  • agreement that we want this
  • to discuss tooling and how to proceed

@nixos-discourse
Copy link

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-02-17-nix-team-meeting-minutes-33/25624/1

Ericson2314 added a commit to obsidiansystems/nix that referenced this issue Feb 23, 2023
@Ericson2314
Generate API docs with Doxygen
a7f0a7c 
The motivation is as stated in issue NixOS#7814: even though the the C++ API
is internal and unstable, people still want it to be well documented for
sake of learning, code review, and other purposes that aren't predicated
on it being stable.

Fixes NixOS#7814
@Ericson2314 Ericson2314 mentioned this issue Feb 23, 2023
Merged
7 tasks
Ericson2314 added a commit to obsidiansystems/nix that referenced this issue Mar 6, 2023
@Ericson2314
Generate API docs with Doxygen
0599fd1 
The motivation is as stated in issue NixOS#7814: even though the the C++ API
is internal and unstable, people still want it to be well documented for
sake of learning, code review, and other purposes that aren't predicated
on it being stable.

Fixes NixOS#7814
Ericson2314 added a commit to obsidiansystems/nix that referenced this issue Mar 6, 2023
@Ericson2314
Generate API docs with Doxygen
d529278 
The motivation is as stated in issue NixOS#7814: even though the the C++ API
is internal and unstable, people still want it to be well documented for
sake of learning, code review, and other purposes that aren't predicated
on it being stable.

Fixes NixOS#7814
Ericson2314 added a commit to obsidiansystems/nix that referenced this issue Mar 6, 2023
@Ericson2314 @roberth
Generate API docs with Doxygen
2048984 
The motivation is as stated in issue NixOS#7814: even though the the C++ API
is internal and unstable, people still want it to be well documented for
sake of learning, code review, and other purposes that aren't predicated
on it being stable.

Fixes NixOS#7814

Co-authored-by: Robert Hensing <[email protected]>
Ericson2314 added a commit to obsidiansystems/nix that referenced this issue Mar 6, 2023
@Ericson2314 @roberth
Generate API docs with Doxygen
f4ead8d 
The motivation is as stated in issue NixOS#7814: even though the the C++ API
is internal and unstable, people still want it to be well documented for
sake of learning, code review, and other purposes that aren't predicated
on it being stable.

Fixes NixOS#7814

Co-authored-by: Robert Hensing <[email protected]>
Ericson2314 added a commit to obsidiansystems/nix that referenced this issue Mar 7, 2023
@Ericson2314 @roberth
Generate API docs with Doxygen
60f6376 
The motivation is as stated in issue NixOS#7814: even though the the C++ API
is internal and unstable, people still want it to be well documented for
sake of learning, code review, and other purposes that aren't predicated
on it being stable.

Fixes NixOS#7814

Co-authored-by: Robert Hensing <[email protected]>
Ericson2314 added a commit to obsidiansystems/nix that referenced this issue Mar 10, 2023
@Ericson2314 @roberth
Generate API docs with Doxygen
6910f5d 
The motivation is as stated in issue NixOS#7814: even though the the C++ API
is internal and unstable, people still want it to be well documented for
sake of learning, code review, and other purposes that aren't predicated
on it being stable.

Fixes NixOS#7814

Co-authored-by: Robert Hensing <[email protected]>
@github-project-automation github-project-automation bot moved this from ⚖ To discuss to 🏁 Assigned in Nix team Mar 10, 2023
@Ericson2314
Copy link
Member Author

For the record, https://hydra.nixos.org/build/224134462#tabs-summary is an example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
Nix team
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Generate API docs with Doxygen obsidiansystems/nix
4 participants
@roberth @Ericson2314 @fricklerhandwerk @nixos-discourse