-
Notifications
You must be signed in to change notification settings - Fork 48
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: Various style and wording tweaks #797
Merged
fdwr
merged 13 commits into
webmachinelearning:main
from
inexorabletash:misc-phrasing-tweaks
Jan 31, 2025
Merged
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
eed4cac
Editorial: Avoid the wordier "the XYZ argument"; just say "XYZ".
inexorabletash 3710c78
Editorial: Eschew vars outside of algorithms
inexorabletash 2941e6d
Editorial: Make dict member linking more consistent
inexorabletash dc897de
Editorial: Format explanatory subscripts to emphasize variables
inexorabletash 8d41d22
Editorial: Drop "options.", rely on linking to provide context
inexorabletash 9342202
Editorial: Linkify all argument/option references outside algorithms
inexorabletash 8b065cb
Incorporate initial feedback
inexorabletash f714fc1
Incorporate more feedback - style/link a few more things
inexorabletash 3fa592e
Merge branch 'refs/heads/review' into misc-phrasing-tweaks
inexorabletash 6fa787c
Merge branch 'refs/heads/review' into misc-phrasing-tweaks
inexorabletash f633230
Merge branch 'refs/heads/review' into misc-phrasing-tweaks
inexorabletash 510b8d2
Merge branch 'refs/heads/review' into misc-phrasing-tweaks
inexorabletash 71cce54
Remove extraneous * in example
inexorabletash File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should
inputChannels
andoutputChannels
be formatted? In*[options.groups, 1, height, width]*
, should we use[*options*.{{MLConv2dOptions/groups}}, 1, *height*, *width*]
?I found the prose of
MLConv2dOptions.inputLayout
andMLConv2dOptions.filterLayout
also refer to variables includinginputChannels
andoutputChannels
etc.,. Should we also format them separately?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Formatted
*inputChannels*
and*outputChannels*
in that instance (in f714fc1) . As noted above, need to decide more generally on how to format shapes.