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

Editorials to 'audio has alternative' rules #1808

Merged
merged 7 commits into from Apr 5, 2022

Conversation

daniel-montalvo
Copy link
Collaborator

Updates to rule and test cases descriptions to 'audio has alternative' rules

Closes issue(s):

  • closes #XXX (ADD ISSUE NUMBER HERE)

Need for Call for Review:
This will require a 1 week Call for Review


Pull Request Etiquette

When creating PR:

  • Make sure you're request
    ing to pull a branch (right side) to the develop branch (left side).
  • Make sure you do not remove the "How to Review and Approve" section in your pull request description

After creating PR:

  • Add yourself (and co-authors) as "Assignees" for PR.
  • Add label to indicate if it's a Rule, Definition or Chore.
  • Link the PR to any issue it solves. This will be done automatically by referencing the issue at the top of this comment in the indicated place.
  • Optionally request feedback from anyone in particular by assigning them as "Reviewers".

When merging a PR:

  • Close any issue that the PR resolves. This will happen automatically upon merging if the PR was correctly linked to the issue, e.g. by referencing the issue at the top of this comment.

How to Review And Approve

  • Go to the “Files changed” tab
  • Here you will have the option to leave comments on different lines.
  • Once the review is completed, find the “Review changes” button in the top right, select “Approve” (if you are really confident in the rule) or "Request changes" and click “Submit review”.
  • Make sure to also review the proposed Call for Review period. In case of disagreement, the longer period wins.

@daniel-montalvo daniel-montalvo self-assigned this Mar 24, 2022
@daniel-montalvo daniel-montalvo added the Review Call 1 week Call for review for small changes label Mar 24, 2022
Copy link
Collaborator

@bruce-usab bruce-usab left a comment

Choose a reason for hiding this comment

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

Looks good! Just asking though, Is audio element (as opposed to audio content or just audio) the best term to be using?

I realize that element is not a change and is the previous phrasing used. I just have some concern for the overlap of the word/concept with other W3C specs.

@Jym77
Copy link
Collaborator

Jym77 commented Mar 24, 2022

@bruce-usab

Looks good! Just asking though, Is audio element (as opposed to audio content or just audio) the best term to be using?

"audio element" is the correct term to use to talk about the HTML element whose name is "audio" (i.e. the element created by the <audio> tag). "Audio content" would be the sound that is produced when this element is rendered on a web page. But "audio content" could be produced by other elements than audio (e.g., a video element, or an object element may have "audio content"). This rule specifically checks something about audio elements, not about other kind of "audio content".

We sort of need that level of precision to make sure the rule (and especially the Applicability) is unambiguous and objective. "audio element" has a precise definition (audio element in HTML specs) while "audio content" would need one (and we would need to make sure that the definition doesn't grab too much or too little).

@bruce-usab
Copy link
Collaborator

@Jym77 — thanks for that clarification. As before, I am of the opinion that this PR is fine.

I had not understood these rules to be only for the HTML5 audio element, so that is important context for me. Thanks again for your time! I will lean on my colleague @kengdoj to get me more up to speed.

@daniel-montalvo daniel-montalvo merged commit 73716a2 into develop Apr 5, 2022
@daniel-montalvo daniel-montalvo deleted the audio-alternatives-editorials branch April 5, 2022 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Review Call 1 week Call for review for small changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants