-
Notifications
You must be signed in to change notification settings - Fork 59
Closed
Labels
Description
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* argumentorthe *bar* valueforms; 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]*.
- Format each term separately; that is,
- 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.
- And to simplify even further: outside algorithms, drop the
Thoughts?
Reactions are currently unavailable