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

Proposed style/wording tweaks #783

Closed
inexorabletash opened this issue Nov 9, 2024 · 1 comment · Fixed by #797
Closed

Proposed style/wording tweaks #783

inexorabletash opened this issue Nov 9, 2024 · 1 comment · Fixed by #797

Comments

@inexorabletash
Copy link
Member

I'd like preliminary feedback on some proposed wording/styling/linking changes:

  • When referring to arguments and options in prose, avoid the wordier the *foo* argument or the *bar* value forms; just use the name alone.
  • When referencing an argument in prose steps, link to it rather than just using formatted text e.g. {{MLGraphBuilder/split(input, splits*, options)/splits}} rather than *splits*.
  • Avoid <var>v</var> or |v| outside of algorithms; Bikeshed interprets these as global variables which can mask errors. Just use *v*.
    • Format each term separately; that is, *splits*[*i*] not *splits[i]*.
  • Dictionary members should be linked to, both in algorithms and in other text. e.g. |options|.{{MLOptionsDict/member}} (in the steps for an algorithm) or *options*.{{MLOptionsDict/member}} (outside an algorithm).
    • And to simplify even further: outside algorithms, drop the *options*. entirely and just link to the member.

Thoughts?

@anssiko
Copy link
Member

anssiko commented Nov 21, 2024

This all sounds great to me! I'd suggest a PR to update SpecCodingConventions.md.

inexorabletash added a commit to inexorabletash/webnn that referenced this issue Dec 7, 2024
inexorabletash added a commit to inexorabletash/webnn that referenced this issue Dec 7, 2024
inexorabletash added a commit to inexorabletash/webnn that referenced this issue Dec 7, 2024
inexorabletash added a commit to inexorabletash/webnn that referenced this issue Dec 7, 2024
Instead of "*foo[bar]*" make it "*foo*[*bar*]" just so that turning
"foo" and "bar" into links is a more atomic operation. Purely
stylistic.

Part of webmachinelearning#783
inexorabletash added a commit to inexorabletash/webnn that referenced this issue Dec 7, 2024
@fdwr fdwr closed this as completed in #797 Jan 31, 2025
fdwr pushed a commit that referenced this issue Jan 31, 2025
* Editorial: Avoid the wordier "the XYZ argument"; just say "XYZ".

Part of #783

* Editorial: Eschew vars outside of algorithms

Part of #783

* Editorial: Make dict member linking more consistent

Part of #783

* Editorial: Format explanatory subscripts to emphasize variables

Instead of "*foo[bar]*" make it "*foo*[*bar*]" just so that turning
"foo" and "bar" into links is a more atomic operation. Purely
stylistic.

Part of #783

* Editorial: Drop "options.", rely on linking to provide context

Part of #783

* Editorial: Linkify all argument/option references outside algorithms

Part of #783

* Incorporate initial feedback

* Incorporate more feedback - style/link a few more things

* Remove extraneous * in example
zolkis pushed a commit to zolkis/webnn that referenced this issue Feb 6, 2025
* Editorial: Avoid the wordier "the XYZ argument"; just say "XYZ".

Part of webmachinelearning#783

* Editorial: Eschew vars outside of algorithms

Part of webmachinelearning#783

* Editorial: Make dict member linking more consistent

Part of webmachinelearning#783

* Editorial: Format explanatory subscripts to emphasize variables

Instead of "*foo[bar]*" make it "*foo*[*bar*]" just so that turning
"foo" and "bar" into links is a more atomic operation. Purely
stylistic.

Part of webmachinelearning#783

* Editorial: Drop "options.", rely on linking to provide context

Part of webmachinelearning#783

* Editorial: Linkify all argument/option references outside algorithms

Part of webmachinelearning#783

* Incorporate initial feedback

* Incorporate more feedback - style/link a few more things

* Remove extraneous * in example
zolkis pushed a commit to zolkis/webnn that referenced this issue Feb 6, 2025
* Editorial: Avoid the wordier "the XYZ argument"; just say "XYZ".

Part of webmachinelearning#783

* Editorial: Eschew vars outside of algorithms

Part of webmachinelearning#783

* Editorial: Make dict member linking more consistent

Part of webmachinelearning#783

* Editorial: Format explanatory subscripts to emphasize variables

Instead of "*foo[bar]*" make it "*foo*[*bar*]" just so that turning
"foo" and "bar" into links is a more atomic operation. Purely
stylistic.

Part of webmachinelearning#783

* Editorial: Drop "options.", rely on linking to provide context

Part of webmachinelearning#783

* Editorial: Linkify all argument/option references outside algorithms

Part of webmachinelearning#783

* Incorporate initial feedback

* Incorporate more feedback - style/link a few more things

* Remove extraneous * in example
zolkis pushed a commit to zolkis/webnn that referenced this issue Feb 6, 2025
* Editorial: Avoid the wordier "the XYZ argument"; just say "XYZ".

Part of webmachinelearning#783

* Editorial: Eschew vars outside of algorithms

Part of webmachinelearning#783

* Editorial: Make dict member linking more consistent

Part of webmachinelearning#783

* Editorial: Format explanatory subscripts to emphasize variables

Instead of "*foo[bar]*" make it "*foo*[*bar*]" just so that turning
"foo" and "bar" into links is a more atomic operation. Purely
stylistic.

Part of webmachinelearning#783

* Editorial: Drop "options.", rely on linking to provide context

Part of webmachinelearning#783

* Editorial: Linkify all argument/option references outside algorithms

Part of webmachinelearning#783

* Incorporate initial feedback

* Incorporate more feedback - style/link a few more things

* Remove extraneous * in example
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.

2 participants