Skip to content

fix(docs): Update documentation for Crossorigin and ElementAttribute enums to clarify attribute representation and compliance with MDN standards.#22

Merged
terabytesoftw merged 2 commits into
mainfrom
fix_mini_6
Jan 10, 2026
Merged

fix(docs): Update documentation for Crossorigin and ElementAttribute enums to clarify attribute representation and compliance with MDN standards.#22
terabytesoftw merged 2 commits into
mainfrom
fix_mini_6

Conversation

@terabytesoftw
Copy link
Copy Markdown
Contributor

@terabytesoftw terabytesoftw commented Jan 10, 2026

Pull Request

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

Summary by CodeRabbit

  • New Features

    • Added support for standardized HTML element attributes including alt, decoding, height, href, referrerpolicy, src, and width.
  • Documentation

    • Improved documentation clarity and updated references to align with MDN standards.

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

…te` enums to clarify attribute representation and compliance with MDN standards.
@terabytesoftw terabytesoftw added the bug Something isn't working label Jan 10, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 10, 2026

Warning

Rate limit exceeded

@terabytesoftw has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 4 minutes and 50 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 5ae6773 and 51b0963.

📒 Files selected for processing (2)
  • src/Element/HasReferrerpolicy.php
  • src/Values/ElementAttribute.php
📝 Walkthrough

Walkthrough

This change introduces a new ElementAttribute enum documenting standardized HTML element attribute names with MDN references, updates the Crossorigin enum docstring for clarity, and adds a corresponding changelog entry for Bug #22.

Changes

Cohort / File(s) Summary
Documentation Updates
CHANGELOG.md, src/Values/Crossorigin.php
Added changelog entry for Bug #22 and refined Crossorigin enum docblock from general description to specific HTML crossorigin attribute documentation.
New Enum Definition
src/Values/ElementAttribute.php
Introduced new string-backed ElementAttribute enum with 8 cases (ALT, DECODING, HEIGHT, HREF, REFERRERPOLICY, SRC, WIDTH), each with MDN reference documentation in docblocks.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

bug

Poem

🐰 A rabbit's tale of clarity bright,
New ElementAttribute shines its light!
With attributes named from A to W,
MDN links guide seekers true.
Crossorigin speaks more clear than before,
Documentation opens wide the door! 🌟

🚥 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 PR title accurately describes the main changes: documentation updates for Crossorigin and ElementAttribute enums to clarify attribute representation and MDN compliance, which aligns with the actual modifications across CHANGELOG.md, Crossorigin.php, and ElementAttribute.php.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/Values/ElementAttribute.php (1)

20-73: Verify PHP version + header conventions for new enum file

  • enum ...: string requires PHP 8.1+ — please confirm the repo’s composer.json PHP constraint matches.
  • Also check whether new files in src/Values/ are expected to include the same copyright/license header style as Crossorigin.
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 67d029f and 5ae6773.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • src/Values/Crossorigin.php
  • src/Values/ElementAttribute.php
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-09T16:05:15.502Z
Learnt from: terabytesoftw
Repo: ui-awesome/html-attribute PR: 18
File: tests/Support/Provider/Global/ContentEditableProvider.php:32-33
Timestamp: 2026-01-09T16:05:15.502Z
Learning: Preserve the original copyright year in file headers when moving PHP source files between packages within the ui-awesome repositories (e.g., from ui-awesome/html-core to ui-awesome/html-attribute). Do not update the header year to the current year; keep the original creation year as stated in the header. This applies to all PHP files throughout the repo that are moved between packages.

Applied to files:

  • src/Values/ElementAttribute.php
  • src/Values/Crossorigin.php
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
  • GitHub Check: phpunit / PHP 8.2-ubuntu-latest
  • GitHub Check: phpunit / PHP 8.4-ubuntu-latest
  • GitHub Check: phpunit / PHP 8.4-windows-2022
  • GitHub Check: phpunit / PHP 8.3-windows-2022
  • GitHub Check: phpunit / PHP 8.1-windows-2022
  • GitHub Check: linter / Super Linter
  • GitHub Check: linter / Super Linter
🔇 Additional comments (2)
src/Values/Crossorigin.php (1)

7-18: Docstring clarification looks good (and header year stays intact)

The updated summary is more precise about the HTML crossorigin attribute, with no behavior change. Header year remains consistent.

CHANGELOG.md (1)

13-13: No changes needed — the changelog entry is accurate.

The use of plural "enums" is correct because the entry refers to both Crossorigin and ElementAttribute together. This PR updates documentation for existing enums (not adding new ones), which is appropriately classified as a bug fix, consistent with the commit message ("fix(docs)") and the project's changelog conventions.

Comment thread src/Values/ElementAttribute.php
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant