Extend internal API docs, part 2 #8133
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
edolstra
reviewed
Mar 31, 2023
edolstra
reviewed
Mar 31, 2023
edolstra
reviewed
Mar 31, 2023
Picking up from NixOS#8111. Co-authored-by: Eelco Dolstra <edolstra@gmail.com>
`///@file` makes them show up in the internal API dos. A tiny few were missing `#pragma once`.
Ericson2314
force-pushed
the
improve-internal-api-docs
branch
from
8ef7962 to
f4ab297
Compare
|
I think I want to be a bit more aggressive merging internal API doc changes than most changes, as to quote @thufschmitt
I.e. even if I did something silly inside PRs, it's probably still a clear net positive as no behavior is changed and no code is refactored. We have plenty of other PRs more deserving of thorough reviews! |
Ericson2314
added a commit
to obsidiansystems/nix
that referenced
this pull request
Apr 1, 2023
99% of this was just reformatting existing comments. Only two exceptions: - Expanded upon `BuildResult::status` compat note - Split up file-level `symbol-table.hh` doc comments to get per-definition docs Also fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces. Picking up from NixOS#8133
7 tasks
Ericson2314
added a commit
to obsidiansystems/nix
that referenced
this pull request
Apr 1, 2023
99% of this was just reformatting existing comments. Only two exceptions: - Expanded upon `BuildResult::status` compat note - Split up file-level `symbol-table.hh` doc comments to get per-definition docs Also fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces. Picking up from NixOS#8133
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/this-month-in-nix-docs-1-march-2023/26913/1 |
Ericson2314
added a commit
to obsidiansystems/nix
that referenced
this pull request
Apr 5, 2023
99% of this was just reformatting existing comments. Only two exceptions: - Expanded upon `BuildResult::status` compat note - Split up file-level `symbol-table.hh` doc comments to get per-definition docs Also fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces. Picking up from NixOS#8133
Ericson2314
added a commit
to obsidiansystems/nix
that referenced
this pull request
Apr 7, 2023
99% of this was just reformatting existing comments. Only two exceptions: - Expanded upon `BuildResult::status` compat note - Split up file-level `symbol-table.hh` doc comments to get per-definition docs Also fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces. Picking up from NixOS#8133
Ericson2314
added a commit
that referenced
this pull request
Apr 7, 2023
* Finish converting existing comments for internal API docs 99% of this was just reformatting existing comments. Only two exceptions: - Expanded upon `BuildResult::status` compat note - Split up file-level `symbol-table.hh` doc comments to get per-definition docs Also fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces. Picking up from #8133 * Fix two things from comments * Use triple-backtick not indent for `dumpPath` * Convert GNU-style `\`..'` quotes to markdown style in API docs This will render correctly.
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/this-month-in-nix-docs-2-april-2023/27899/1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The internal API docs now contain more useful information.
Context
Picking up from #8111.
Checklist for maintainers
Maintainers: tick if completed or explain if not relevant
tests/**.shsrc/*/teststests/nixos/*Priorities
Add 👍 to pull requests you find important.