fix(test): Update documentation tests classes for clarity and consistency.

[terabytesoftw]

Pull Request

Q	A
Is bugfix?	✔️
New feature?	❌
Breaks BC?	❌

Summary by CodeRabbit

• Documentation
  • Standardized test suite documentation across all test files by simplifying docblocks to focus on core test coverage: immutability, rendering behavior, attribute handling, and validation.
  • Updated test data provider documentation to clarify their representative input/output purposes.
  • Refined test stub enum descriptions for better clarity in the test suite.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Docblocks across 70+ test classes, data providers, and utility files are updated to use concise, test-focused descriptions. Verbose specifications-oriented language is replaced with simplified text emphasizing immutability, rendering behavior, and validation. No executable code logic changes.

Changes

Cohort / File(s)	Summary
CHANGELOG Entry CHANGELOG.md	Added changelog entry for bug fix #25 regarding documentation test class updates.
Test Classes - Element Attributes tests/Element/Has{Alt,Decoding,Height,Href,Referrerpolicy,Src,Width}Test.php	Docblocks simplified: replaced verbose specification-focused descriptions with concise summaries emphasizing immutability, rendering, and attribute behavior validation. No functional test logic changed.
Test Classes - Global Attributes (Batch 1) tests/Global/{CanBeAutofocus,CanBeHidden,HasAccesskey,HasAria,HasClass,HasContentEditable,HasData,HasDir}Test.php	Docblocks updated: shifted from HTML Living Standard references to focused descriptions of rendered output, immutability, and attribute override behavior. Test logic unchanged.
Test Classes - Global Attributes (Batch 2) tests/Global/{HasDraggable,HasEvents,HasId,HasLang,HasMicroData,HasRole,HasSpellcheck,HasStyle,HasTabIndex,HasTitle,HasTranslate}Test.php	Docblocks refined: simplified narrative from broad trait behavior to concise coverage of immutability, rendering expectations, and validation. No test implementation changes.
Additional Test Classes tests/{HasCrossorigin,HasFetchpriority,HasRel}Test.php	Docblocks simplified to concise descriptions of attribute management and test coverage. Only documentation text modified.
Utility - Data Generator tests/Support/EnumDataGenerator.php	Class description shortened; PHPDoc return type for cases() method refined from array{UnitEnum, mixed[], string|UnitEnum, string, string} to array{UnitEnum, mixed[], UnitEnum, string, string}. Documentation clarified.
Data Providers - General tests/Support/Provider/{Crossorigin,Fetchpriority,Rel}Provider.php	Docblocks compressed: replaced detailed scenario narratives with concise descriptions of representative input/output pairs. Method signatures unchanged.
Data Providers - Element Attributes tests/Support/Provider/Element/{Alt,Decoding,Height,Href,Referrerpolicy,Src,Width}Provider.php	Docblocks streamlined: removed extensive test data explanations, replaced with brief descriptions. No code logic or return types altered.
Data Providers - Global Attributes (Batch 1) tests/Support/Provider/Global/{Accesskey,Autofocus,Hidden,Id,Lang,Role,Spellcheck,Title,Translate}Provider.php	Docblocks simplified: verbose test coverage narratives replaced with concise descriptions of representative attribute pairs. Method signatures remain unchanged.
Data Providers - Global Attributes (Batch 2) tests/Support/Provider/Global/{Aria,Class,ContentEditable,Data,Dir,Draggable,Event}Provider.php	Docblocks greatly reduced: removed detailed descriptions and feature lists while preserving method implementations. Public API signatures unchanged.
Data Providers - Global Microdata & Other tests/Support/Provider/Global/{ItemId,ItemProp,ItemRef,ItemScope,ItemType}Provider.php	Docblocks condensed: replaced multi-sentence scenarios with generic descriptions of representative input/output pairs. All implementations preserved.
Data Providers - Miscellaneous tests/Support/Provider/Global/{Style,TabIndex}Provider.php	Docblocks simplified; TabIndexProvider's invalidValues() method retains concrete return data. Documentation-only modifications.
Stub Value Enums tests/Support/Stub/Values/{AlertType,ButtonSize,Priority,Status}.php	PHPDoc updated: replaced domain-specific descriptions with test-focused language emphasizing deterministic stub values. Enum cases and signatures unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~20 minutes

Possibly related PRs

• feat(attribute): Add HasDecoding trait and decoding() method to manage decoding attribute for HTML/SVG elements. #20: Updates test class docblocks for HasDecoding trait, directly related to docblock changes in this PR's HasDecodingTest.php.
• fix(docs): Improve test suite documentation for HTML attributes with detailed descriptions and coverage. #11: Overlapping docblock modifications to identical test classes and provider files (HasAlt/HasHeight/HasSrc/HasWidth, Referrerpolicy/Rel providers).

Poem

🐰 Docstrings flutter, verbose turned to bright,
Test descriptions now concise and tight,
Clarity blooms where words were thick—
Our burrow of tests is trim and quick! 🌿

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: updating documentation in test classes for clarity and consistency. This aligns with the changeset's primary focus.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

tests/Element/HasDecodingTest.php (1)

18-31: Update copyright year to 2025 for consistency.

All other test files in tests/Element/ use 2025 (HasWidthTest, HasReferrerpolicyTest, HasHrefTest, HasSrcTest, HasHeightTest, HasAltTest, etc.). The 2026 copyright in HasDecodingTest.php is inconsistent and should be reverted to the original creation year.

Required change

- * `@copyright` Copyright (C) 2026 Terabytesoftw.
+ * `@copyright` Copyright (C) 2025 Terabytesoftw.