doc(os/linux): fix page_size doclint warning#311
Merged
Conversation
The page_size docstrings in riscv64.mach and aarch64.mach put a NOTE block between two `---` separators, so the doclint parsed `NOTE` as a documented component and warned 'documented component matches no parameter, field, generic, or ret'. Move the NOTE into the summary block (above the `---`) so the doc-item section holds only `ret`. Closes #310
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Closes #310
The
page_sizedocstrings insrc/system/os/linux/riscv64.machandsrc/system/os/linux/aarch64.machput aNOTE:block between two# ---separators, so the doclint parsedNOTEas a documented component and loggeddocumented component matches no parameter, field, generic, or retwhenever those modules compiled (surfaced by the cross-riscv64 lane). Moved the NOTE into the summary block (above the---) so the doc-item section holds onlyret. Pure comment change.Verification
mach test .-> 563/563.