Skip to content

Docs: fix up inline @var docblocks#22142

Merged
jrfnl merged 1 commit intotrunkfrom
JRF/Docs/fix-inline-var-annotations
Mar 24, 2025
Merged

Docs: fix up inline @var docblocks#22142
jrfnl merged 1 commit intotrunkfrom
JRF/Docs/fix-inline-var-annotations

Conversation

@jrfnl
Copy link
Copy Markdown
Contributor

@jrfnl jrfnl commented Mar 24, 2025

Context

  • Improve code documentation

Summary

This PR can be summarized in the following changelog entry:

  • Improve the format of code comments containing the @var tag.

Relevant technical choices:

These should always contain a @var tag following the following format: @var Type $name.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • N/A

@jrfnl jrfnl added yoast cs/qa changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog labels Mar 24, 2025
@jrfnl jrfnl added this to the 24.9 milestone Mar 24, 2025
These should always contain a `@var` tag following the following format: `@var Type $name`.
@jrfnl jrfnl force-pushed the JRF/Docs/fix-inline-var-annotations branch from 781e2be to 7f3e2d5 Compare March 24, 2025 21:58
@coveralls
Copy link
Copy Markdown

Pull Request Test Coverage Report for Build b996f793cdc2d4e69969456937d1f341c9fcd357

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 48.68%

Totals Coverage Status
Change from base Build b5612f492502e6656066093033050ab01cb576f0: 0.0%
Covered Lines: 16083
Relevant Lines: 33038

💛 - Coveralls

@jrfnl jrfnl merged commit bc9a1fb into trunk Mar 24, 2025
27 checks passed
@jrfnl jrfnl deleted the JRF/Docs/fix-inline-var-annotations branch March 24, 2025 22:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog yoast cs/qa

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants