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: Markdown/markup and link default tweaks #116

Merged
merged 2 commits into from May 31, 2023
Merged

Conversation

inexorabletash
Copy link
Member

@inexorabletash inexorabletash commented May 31, 2023

  • <aside> is a flow element; don't use it like a block. Use <div>
  • Use "note:" markdown, which Bikeshed styles better
  • Disambiguate "user agent" link

Preview | Diff

* <aside> is a flow element; don't use it like a block. Use <div>
* Use "note:" markdown, which Bikeshed styles better
* Disambiguate "user agent" link
@inexorabletash
Copy link
Member Author

@saschanaz can can you review? (low priority)

@saschanaz
Copy link
Member

Perhaps escape <aside> in the commit message?

index.bs Outdated
<aside class=note>
[=/Agents=] roughly correspond to windows (tabs), iframes, and workers. [=/Agent clusters=] correspond to independent processes in some user agent implementations.
</aside>
note: [=/Agents=] roughly correspond to windows (tabs), iframes, and workers. [=/Agent clusters=] correspond to independent processes in some user agent implementations.
Copy link
Member

Choose a reason for hiding this comment

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

I personally prefer NOTE: as that's the rendered result

@@ -15,6 +15,10 @@ Markup Shorthands: css no, markdown yes
Assume Explicit For: yes
</pre>

<pre class=link-defaults>
spec:infra; type:dfn; text:user agent
Copy link
Member

Choose a reason for hiding this comment

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

What happens without this?

Copy link
Member Author

Choose a reason for hiding this comment

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

LINE ~146: Multiple possible 'user agent' dfn refs for '['/']'.
Arbitrarily chose https://infra.spec.whatwg.org/#user-agent
To auto-select one of the following refs, insert one of these lines into a <pre class=link-defaults> block:
spec:infra; type:dfn; text:user agent
The following refs show up multiple times in their spec, in a way that Bikeshed can't distinguish between. Either create a manual link, or ask the spec maintainer to add disambiguating attributes (usually a for='' attribute to all of them).
spec:css2; type:dfn; for:/; text:user agent
  https://www.w3.org/TR/CSS21/conform.html#ua
  https://www.w3.org/TR/CSS21/conform.html#user-agent
[=/user agent=]

Copy link
Member

Choose a reason for hiding this comment

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

Sounds like CSS should be fixed, but okay.

@inexorabletash inexorabletash merged commit 84a8cb1 into main May 31, 2023
2 checks passed
github-actions bot added a commit that referenced this pull request May 31, 2023
SHA: 84a8cb1
Reason: push, by inexorabletash

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@saschanaz saschanaz deleted the notes branch May 31, 2023 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants