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.

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

Miscellaneous documentation fixes and updates #1310

Merged
merged 8 commits into from
Nov 5, 2024

Conversation

msimberg
Copy link
Contributor

@msimberg msimberg commented Nov 1, 2024

See individual commit messages for a description of what has changed.

Fixes #1308.

@msimberg msimberg added this to the 0.30.0 milestone Nov 1, 2024
@msimberg msimberg self-assigned this Nov 1, 2024
Copy link

codacy-production bot commented Nov 1, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.06% (target: -1.00%) (target: 90.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (2f15e1d) 18282 13802 75.50%
Head commit (7ebb1ec) 18282 (+0) 13813 (+11) 75.56% (+0.06%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#1310) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

@msimberg msimberg force-pushed the docs-miscellaneous-fixes branch from e528bf6 to da24825 Compare November 1, 2024 13:48
@msimberg
Copy link
Contributor Author

msimberg commented Nov 4, 2024

Needs #1314 for the ripgrep check for @command vs \command.

@msimberg msimberg force-pushed the docs-miscellaneous-fixes branch from da24825 to ac77b1f Compare November 4, 2024 11:46
@msimberg msimberg force-pushed the docs-miscellaneous-fixes branch from ac77b1f to 7ebb1ec Compare November 4, 2024 12:27
Copy link
Contributor

@aurianer aurianer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks!

@msimberg msimberg merged commit 62bd1dd into pika-org:main Nov 5, 2024
36 of 37 checks passed
@msimberg msimberg deleted the docs-miscellaneous-fixes branch November 5, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Archive
Development

Successfully merging this pull request may close these issues.

Consistently use \command instead of @command in doxygen documentation
2 participants