Skip to content

Docs: various fixes#22140

Merged
jrfnl merged 5 commits intotrunkfrom
JRF/Docs/various-fixes
Mar 24, 2025
Merged

Docs: various fixes#22140
jrfnl merged 5 commits intotrunkfrom
JRF/Docs/various-fixes

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 code documentation.

Relevant technical choices:

Docs: add various missing @return void

Docs: various type formatting fixes

  • The "key" type and the "value" type in an array<> type should be separated by a comma + space.
  • @var tags should not duplicate the property name.
  • Fix a few incorrect types

Docs: fix typos

Docs: use more consistent type order

Docs: fix tag alignment

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 added 5 commits March 24, 2025 22:21
* The "key" type and the "value" type in an `array<>` type should be separated by a comma + space.
* `@var` tags should not duplicate the property name.
* Fix a few incorrect types
@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
@jrfnl jrfnl changed the title Jrf/docs/various fixes Docs: various fixes Mar 24, 2025
@jrfnl jrfnl merged commit 149ef1d into trunk Mar 24, 2025
30 checks passed
@jrfnl jrfnl deleted the JRF/Docs/various-fixes branch March 24, 2025 21:29
@coveralls
Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 513cd9d38b320359f686ea06ae6b8c856f728c6a

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 f44229b0911ab3251ebf3aec976097d0ed682dee: 0.0%
Covered Lines: 16083
Relevant Lines: 33038

💛 - Coveralls

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