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

docs: tweak spelling from “bread-crumb” to “breadcrumb” #7165

Merged
merged 6 commits into from
Oct 11, 2021
Merged

docs: tweak spelling from “bread-crumb” to “breadcrumb” #7165

merged 6 commits into from
Oct 11, 2021

Conversation

j9t
Copy link
Contributor

@j9t j9t commented Oct 6, 2021

* Fixed typo

Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
* Adjusted case (“wiki”—should otherwise be qualified for more clarity)
* Rephrased “microformats wiki existing-rel-values page” (super-long, reads awkwardly)
* Added article to make `source` element conditions more readable
* Limited repetition (double “and so forth”)
* Made layout/transparency note slightly more clear

Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
Replaces #7154

Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
Copy link
Member

@annevk annevk left a comment

Choose a reason for hiding this comment

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

Could you also create a PR for https://whatwg.org/style-guide. See https://github.com/whatwg/whatwg.org/blob/main/whatwg.org/style-guide. There might be other things you could add there based on the things you've observed.

@@ -69478,7 +69478,7 @@ dictionary <dfn dictionary>ValidityStateFlags</dfn> {

<h4 id="rel-up">Bread crumb navigation</h4>

<p>This specification does not provide a machine-readable way of describing bread-crumb navigation
<p>This specification does not provide a machine-readable way of describing breadcrumb navigation
menus. Authors are encouraged to just use a series of links in a paragraph. The <code>nav</code>
Copy link
Collaborator

Choose a reason for hiding this comment

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

since you're editing this, might we say authors should put these breadcrumb links into a paragraph or list?

it's quite common, and i'd submit even more common than using a paragraph, to use a list to markup a breadcrumb navigation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I deem this reasonable but opt out of changes that don’t relate to the original intent of this PR (I’m running out of capacity). If this meets Anne’s, Domenic’s, and other’s expectations that may be a small additional PR to be opened.

Copy link
Member

Choose a reason for hiding this comment

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

On the face of it that sounds reasonable to me. When you open a PR perhaps cite some of these examples? And maybe we should also add one to the specification?

(I agree it's out-of-scope here as this is purely an editorial manner and changing this would affect conformance.)

@j9t
Copy link
Contributor Author

j9t commented Oct 8, 2021

Thanks for reviewing, @annevk. I took note on https://whatwg.org/style-guide and will follow up. Good to merge this one, then?

annevk pushed a commit to whatwg/whatwg.org that referenced this pull request Oct 11, 2021
@annevk annevk merged commit cd143c7 into whatwg:main Oct 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants