Update operators.py --- copy edits (grammar, consistency, clarity) - take 2 #1158
Conversation
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
In addition to fixing typos for the word "specialized" and changed "dedicated for" to "dedicated to" -- I also adjusted something that seemed to render differently than planned -- The auto docs said "additional arguments are field names passed to the function" but it showed up on the web page as "(additional arguments are field names passed to the) - name of function" -- it seemed to render this way since the word "function" was at the end. Incorporating Yoav's new suggested text for clarity, I also switched the final words so that it didn't end with the word function, which seemed to be picked up there by the parser. I hope this renders better. We can check by looking at the operators.html page on the resulting documentation website after this commit is approved, and if it doesn't work tweak from there. Please review. Thanks! Signed-off-by: welisheva22 <welisheva22@gmail.com>
elronbandel
approved these changes
Aug 19, 2024
csrajmohan
pushed a commit
that referenced
this pull request
Aug 29, 2024
…take 2 (#1158) Update operators.py --- copy edits (grammar, consistency, clarity) In addition to fixing typos for the word "specialized" and changed "dedicated for" to "dedicated to" -- I also adjusted something that seemed to render differently than planned -- The auto docs said "additional arguments are field names passed to the function" but it showed up on the web page as "(additional arguments are field names passed to the) - name of function" -- it seemed to render this way since the word "function" was at the end. Incorporating Yoav's new suggested text for clarity, I also switched the final words so that it didn't end with the word function, which seemed to be picked up there by the parser. I hope this renders better. We can check by looking at the operators.html page on the resulting documentation website after this commit is approved, and if it doesn't work tweak from there. Please review. Thanks! Signed-off-by: welisheva22 <welisheva22@gmail.com> Co-authored-by: Elron Bandel <elronbandel@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In addition to fixing typos for the word "specialized" and changed "dedicated for" to "dedicated to" -- I also adjusted something that seemed to render differently than planned --
The auto docs said
"additional arguments are field names passed to the function"
but it showed up on the web page as
"(additional arguments are field names passed to the) - name of function"
-- it seemed to render this way since the word "function" was at the end.
Incorporating Yoav's new suggested text for clarity, I also switched the final words so that it didn't end with the word function, which seemed to be picked up there by the parser.
I hope this renders better. We can check by looking at the operators.html page on the resulting documentation website after this commit is approved, and if it doesn't work tweak from there.
Please review. Thanks!