You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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?
The text was updated successfully, but these errors were encountered:
I'd like preliminary feedback on some proposed wording/styling/linking changes:
the *foo* argument
orthe *bar* value
forms; just use the name alone.{{MLGraphBuilder/split(input, splits*, options)/splits}}
rather than*splits*
.<var>v</var>
or|v|
outside of algorithms; Bikeshed interprets these as global variables which can mask errors. Just use*v*
.*splits*[*i*]
not*splits[i]*
.|options|.{{MLOptionsDict/member}}
(in the steps for an algorithm) or*options*.{{MLOptionsDict/member}}
(outside an algorithm).*options*.
entirely and just link to the member.Thoughts?
The text was updated successfully, but these errors were encountered: