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

Editorial pass by Bruce for use of "requires" #328

Closed
wants to merge 9 commits into from
Closed

Conversation

bruce-usab
Copy link
Contributor

Still a work in progress...

- Added year and Revised Standards to 508 reference
- added P inside of most DIVs because vertical spacing was not displaying in preview.
- Used dashes for 2nd level list items, to better distinguish for anyone using a screen reader.
- Conformed white space.
- replace "requires" with "relies upon"

editorial
 - Replaced use of single list item DL with blockquote.  DT were just repeating the previous line, and blockquote is just as semantic as DD.
- changed some DIV class assignments from NOTE to EXAMPLE
- I removed paragraph breaks between HTML blocks, mostly because that is a problem for my agency repo.  W3C repo probably is not as finicky.  Preview (from markdown editor) has a little more fidelity.
What I tried to improve:
- include definitions as something regulators should not tweak
- have phrasing track literally to WCAG in a few more places
Copy link

netlify bot commented Mar 20, 2024

Deploy Preview for wcag2ict ready!

Name Link
🔨 Latest commit a69ca73
🔍 Latest deploy log https://app.netlify.com/sites/wcag2ict/deploys/66049148c4aa0f0008a8b342
😎 Deploy Preview https://deploy-preview-328--wcag2ict.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.

@bruce-usab bruce-usab marked this pull request as draft March 20, 2024 19:04
@bruce-usab bruce-usab self-assigned this Mar 20, 2024
@bruce-usab
Copy link
Contributor Author

Should close #329

comments-on-conformance.md Outdated Show resolved Hide resolved
comments-on-conformance.md Outdated Show resolved Hide resolved
comments-on-conformance.md Outdated Show resolved Hide resolved
introduction.md Outdated Show resolved Hide resolved
introduction.md Outdated Show resolved Hide resolved
introduction.md Outdated Show resolved Hide resolved
key-terms.md Show resolved Hide resolved
key-terms.md Show resolved Hide resolved
@maryjom
Copy link
Contributor

maryjom commented Mar 26, 2024

@bruce I'm a bit worried about the scope of edits in this PR. Doesn't seem like any of them had anything to do with the topic for the PR which was to edit for the uses of "requires".

Also, each file in this PR has some merge conflicts which makes this a complicated merge since it covers so many files.

bruce-usab and others added 4 commits March 27, 2024 17:20
Co-authored-by: Mary Jo Mueller <maryjom@us.ibm.com>
Co-authored-by: Mary Jo Mueller <maryjom@us.ibm.com>
Co-authored-by: Mary Jo Mueller <maryjom@us.ibm.com>
Co-authored-by: Mary Jo Mueller <maryjom@us.ibm.com>
@bruce-usab bruce-usab marked this pull request as ready for review March 27, 2024 21:32
@bruce-usab
Copy link
Contributor Author

@maryjom I concur with your changes and accepted/resolved conversation in each case.

@bruce I'm a bit worried about the scope of edits in this PR. Doesn't seem like any of them had anything to do with the topic for the PR which was to edit for the uses of "requires".

They were all markdown files I was lead to from search of require/s/ed/ing on recent editors' draft. I regret that I did not take notes on how I came to target which files.

I am concerned that I did not find all of the uses of requir* to review.

Also, each file in this PR has some merge conflicts which makes this a complicated merge since it covers so many files.

I have resolved the merge conflicts. Sadly, that is an exercise which I have some practice!

* [1.4.2 Audio Control](http://www.w3.org/TR/WCAG22/#audio-control);
* [2.1.2 No Keyboard Trap](http://www.w3.org/TR/WCAG22/#no-keyboard-trap);
* [2.2.2 Pause, Stop, Hide](http://www.w3.org/TR/WCAG22/#pause-stop-hide).
* [2.3.1 Three Flashes or Below Threshold](http://www.w3.org/TR/WCAG22/#three-flashes-or-below-threshold);

Also, as noted in the Introduction, it wasn't possible to unambiguously carve up software into discrete pieces, and so the unit of evaluation for non-web software is the whole software program. As with any software testing this can be a very large unit of evaluation, and methods similar to standard software testing might be used.
As noted in the [Introduction](#introduction), it isn’t possible to unambiguously divide software into discrete pieces. The unit of evaluation for non-web software is the whole software program. As with any software testing this can be a very large unit of evaluation, and methods similar to standard software testing may be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
As noted in the [Introduction](#introduction), it isn’t possible to unambiguously divide software into discrete pieces. The unit of evaluation for non-web software is the whole software program. As with any software testing this can be a very large unit of evaluation, and methods similar to standard software testing may be used.
As noted in the [Introduction](#introduction), it isn’t possible to unambiguously divide software into discrete pieces. Therefore, the unit of evaluation for non-web software is the whole software program. As with any software testing this can be a very large unit of evaluation, and methods similar to standard software testing may be used.

@bruce-usab
Copy link
Contributor Author

@maryjom -- I think this PR and related branch is OBE and can be deleted.

@bruce-usab bruce-usab marked this pull request as draft May 1, 2024 21:27
@maryjom
Copy link
Contributor

maryjom commented May 6, 2024

@maryjom -- I think this PR and related branch is OBE and can be deleted.

@bruce-usab OBE? Does this mean outdated by your other PRs?

@maryjom maryjom closed this May 14, 2024
@maryjom
Copy link
Contributor

maryjom commented May 14, 2024

This PR was overtaken by other more focused PRs.

@bruce-usab bruce-usab deleted the bruce-requires branch June 20, 2024 14:33
@bruce-usab bruce-usab restored the bruce-requires branch June 20, 2024 14:34
@bruce-usab bruce-usab deleted the bruce-requires branch June 20, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants