Finish converting existing comments for internal API docs #8146
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
Ericson2314
added
the
contributor-experience
Ericson2314
force-pushed
the
improve-internal-api-docs
branch
from
e74f417 to
8fe8143
Compare
7 tasks
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/2023-04-03-nix-team-meeting-minutes-46/27008/1 |
Ericson2314
force-pushed
the
improve-internal-api-docs
branch
from
8fe8143 to
7a25903
Compare
roberth
reviewed
Apr 7, 2023
roberth
reviewed
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
This will render correctly.
Ericson2314
force-pushed
the
improve-internal-api-docs
branch
from
7a25903 to
40dec7f
Compare
roberth
approved these changes
Apr 7, 2023
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.
99% of this was just reformatting existing comments. Only two exceptions:
Expanded upon
BuildResult::statuscompat noteSplit up file-level
symbol-table.hhdoc comments to get per-definition docsAlso fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces.
Motivation
It is better to see our current documentation comments rendered!
Context
Picking up from #8133
Checklist for maintainers
Maintainers: tick if completed or explain if not relevant
tests/**.shsrc/*/teststests/nixos/*Priorities
Add 👍 to pull requests you find important.