Conversation
…eferences sections, including the text represnted in code which has been COMMENTED OUT, NOT THE CODE ITSELF
This file contains hidden or 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
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.
I changed tenses to maintain present tense. The second POV is standard for docs, and it maintains consistency with the rest of your wording.
Like "login" (noun) and "log in" (verb) , "rollback" and "rollsback" function as two different kinds of word. "rollback", the function and API call, is a noun. "Rolls back" is the verb, the act of calling a rollback. This is another docs standard thing so the user can tell whether you're describing a thing or telling them that thing is happening.
Some of the API calls you named are clear enough not to need to redescribe them as a separate line. (gg!)
Under run_in_new_ctx, used the code tag for "callable_func" even if it's an example, so it sticks out and is clear it needs to be an API call.
If I made changes to the text about the code but that text was replicated inside code examples, I made those changes there, too. I did NOT touch anything else about your examples and the actual code therein. I tested all my work to make sure that didn't happen, but please feel free to call me on it if I messed that up.