Skip to content

Fix CSS attribute parser return type docs#189

Open
ydah wants to merge 1 commit into
mainfrom
fix/css-attributes-parser-return-type
Open

Fix CSS attribute parser return type docs#189
ydah wants to merge 1 commit into
mainfrom
fix/css-attributes-parser-return-type

Conversation

@ydah

@ydah ydah commented Jun 23, 2026

Copy link
Copy Markdown
Member

Fix the YARD return type for CssAttributesParser#parse and CssSelector.attributes.

Both methods return an attributes hash, but their documentation described the return value as an array of strings. This updates the comments to match the actual API and avoid confusion when maintaining the parser.


Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with main (if not - rebase it).
  • Squashed related commits together.
  • [-] Added tests.
  • Updated documentation.
  • [-] Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
  • The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

If you have created a new cop:

  • [-] Added the new cop to config/default.yml.
  • [-] The cop is configured as Enabled: pending in config/default.yml.
  • [-] The cop documents examples of good and bad code.
  • [-] The tests assert both that bad code is reported and that good code is not reported.
  • [-] Set VersionAdded: "<<next>>" in default/config.yml.

If you have modified an existing cop's configuration options:

  • [-] Set VersionChanged: "<<next>>" in config/default.yml.

@ydah ydah requested a review from a team as a code owner June 23, 2026 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant