Skip to content

Set detail not details #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 21, 2022
Merged

Set detail not details #11

merged 2 commits into from
Dec 21, 2022

Conversation

khiga8
Copy link
Contributor

@khiga8 khiga8 commented Dec 20, 2022

I noticed that the lint error message for no-default-alt-text doesn't include the error context like, [For image: Screen Shot 2022-06-26 at 7 41 30 PM] even though it's defined in the rule.

This is because details is being set instead of detail. I fixed this issue and added a test to ensure the error message and error detail is what we expect.

Now the error message that appears as part of the lint error should include the error context:

GH001/no-default-alt-text Images should not use the MacOS default screenshot filename as alternate text (alt text). If you have not changed this file, try merging main with your branch. 
For more information see: https://primer.style/design/accessibility/alternative-text-for-images 
[For image: Screen Shot 2022-06-26 at 7 41 30 PM]

@khiga8 khiga8 marked this pull request as ready for review December 20, 2022 22:59
@khiga8 khiga8 requested a review from a team as a code owner December 20, 2022 22:59
@accessibility-bot
Copy link
Collaborator

👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.

  • 💻 On PRs for our review: please provide a review environment with steps to validate, screenshots (with alt text), or videos (with description following) demonstrating functionality we should be checking. This will help speed up our review and feedback cycle.
  • ⚠️ If this is urgent, please visit us in #accessibility on Slack and tag the first responder(s) listed in the channel topic.

Copy link
Contributor

@smockle smockle left a comment

Choose a reason for hiding this comment

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

Good catch; thanks for fixing this! I left one non-blocking comment.

@khiga8 khiga8 merged commit 18247e8 into main Dec 21, 2022
@khiga8 khiga8 deleted the kh-set-detail-no-details branch December 21, 2022 14:53
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.

3 participants