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

Request for Key Term description for 'repair techniques' #2563

Closed
LaurenceRLewis opened this issue Aug 3, 2022 · 5 comments
Closed

Request for Key Term description for 'repair techniques' #2563

LaurenceRLewis opened this issue Aug 3, 2022 · 5 comments

Comments

@LaurenceRLewis
Copy link
Contributor

Hi I have been asked to clarify the term Repair Techniques as mentioned in the document 'Understanding Success Criterion 4.1.1: Parsing'.

"Since repair techniques vary among user agents, authors cannot assume that content will be accurately parsed into a data structure or that it will be rendered correctly by specialized user agents, including assistive technologies..."

Could this be added to a 'Key Terms' for the 4.1.1 Parsing understanding document.

@bruce-usab bruce-usab self-assigned this Aug 3, 2022
@bruce-usab
Copy link
Contributor

Thank you for raising this question!

Clarifying edits to Understanding are most welcome. We have "key terms" in other Understanding pages, so adding that section for this one seems like a reasonable approach. I am not sure that goes quite far enough. I think it might be worth some discussion so as to tease out better what is meant by the concept.

For starters, since we use Techniques for human author best practices, it strikes me as confusing to be using that word here for automated machine browser error recovery.

@LaurenceRLewis do you have a proposal for something like a glossary term?

@patrickhlauke
Copy link
Member

glossary terms are part of the normative document though, so not limited to understanding.

In general though, I think rather than making up a term definition, it may be easier to just make that sentence itself a bit more immediately readable/understandable. e.g.

"Since the way user agents will attempt to parse and error-correct malformed or invalid markup may vary among user agents, authors..."

@LaurenceRLewis
Copy link
Contributor Author

@patrickhlauke I think updating the content to make the sentence more immediately readable is a good idea. Readers then do not have to relocate on the page to understand the term.

"Since the way user agents will attempt to parse and error-correct malformed or invalid markup may vary among user agents, authors..."

@patrickhlauke
Copy link
Member

Made an initial stab here #2566

@patrickhlauke
Copy link
Member

Closing, as #2566 was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants