Skip to content
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

Harmonise wording for techniques checks/steps #3915

Merged
merged 8 commits into from
Aug 7, 2024

Conversation

patrickhlauke
Copy link
Member

@patrickhlauke patrickhlauke commented Jun 25, 2024

Currently, techniques use a mix of wording If step X... and If check X..., as well as a few outlier "If test procedure X...". Most prefix the step/check number with #, but some don't. And conceptually, I think it makes more sense saying that a check is true/false, rather than a step being true/false.

This PR tries to harmonise this, settling for check and adding missing # (though, it has to be said, this use of the octothorpe is a bit US-centric, so maybe we want to harmonise to not having it?)

@patrickhlauke patrickhlauke force-pushed the patrickhlauke-techniques-step-fail-language-tweak branch from 177df34 to f778431 Compare June 25, 2024 10:59
@patrickhlauke patrickhlauke requested a review from fstrr June 25, 2024 11:06
@fstrr
Copy link
Contributor

fstrr commented Jun 25, 2024

Agree on the US-centric use of the # symbol. I've often considered yoinking it out and would be fine with it being removed.

@patrickhlauke
Copy link
Member Author

Point to discuss in our next WCAG 2.x meeting then ... if we want to yoink # out, I can do a big find/replace and add it as a commit here.

@mbgower mbgower mentioned this pull request Jun 28, 2024
@alastc
Copy link
Contributor

alastc commented Jun 28, 2024

I think aligning with the earlier examples is probably best (and the least amount of files changed), which is what you've done. That will also ruffle the least feathers.

@mbgower mbgower requested a review from ljoakley June 28, 2024 15:29
@ljoakley ljoakley self-assigned this Jun 28, 2024
changing "check #1 is true and check #2 is true" to match the rest of changes: "check #1 and #2 is true"
removed the word "both" as none of the other changes use this
Copy link
Contributor

@ljoakley ljoakley left a comment

Choose a reason for hiding this comment

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

completed with a few changes

@mbgower
Copy link
Contributor

mbgower commented Jul 5, 2024

@shawna-slh Is there any style decision on use of the pound symbol (#) in front of ordered list references?

@shawna-slh
Copy link
Contributor

shawna-slh commented Jul 9, 2024

Thanks for the ping @mbgower ! We don't currently have that in our Style guide. (I prefer without the # - yet don't have any support for or against that. update: I've noticed myself sometimes wanting to use "#" in such cases.) From a quick search, I don't find guidance in leading Style Guides -- so it needs more research.

The good news is we have a new WAI staff person coming on the end of the month who will be great at citing sources for a decision.

Are y'all comfortable leaving this issue open for a few weeks until we can get back to it?

(p.s. thanks to @patrickhlauke I learned a new term, "octothorpe".)

@patrickhlauke
Copy link
Member Author

Are y'all comfortable leaving this issue open for a few weeks until we can get back to it?

no rush from my perspective. I'd rather wait and then do all the changes in a oner, once we have a decision on the #

@mbgower
Copy link
Contributor

mbgower commented Jul 26, 2024

@shawna-slh Sorry, I missed those final comments when I brought this into our current review cycle.
If someone gets to this by the start of August, we can just incorporate your change, otherwise we'll just push a second update when you make your recommendation.

@shawna-slh
Copy link
Contributor

@tamsinewing555 will probably get to it within a few days :)

Copy link

netlify bot commented Aug 7, 2024

Deploy Preview for wcag2 ready!

Name Link
🔨 Latest commit 551193b
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/66b3f34ad654da000892557c
😎 Deploy Preview https://deploy-preview-3915--wcag2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mbgower mbgower merged commit 014f0e3 into main Aug 7, 2024
5 checks passed
@mbgower mbgower deleted the patrickhlauke-techniques-step-fail-language-tweak branch August 7, 2024 22:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants