Skip to content

made minor/moderate wording changes from the Usage Examples and API R…#2

Merged
annibond merged 1 commit intomainfrom
apidocs
Jan 8, 2026
Merged

made minor/moderate wording changes from the Usage Examples and API R…#2
annibond merged 1 commit intomainfrom
apidocs

Conversation

@annibond
Copy link
Owner

@annibond annibond commented Jan 8, 2026

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.

  1. "An example of a handle that uses a session in context, but commits manually and even closes the session to release the connection" -> "An example of a handle that uses a session in context, but commits manually and closes the session to release the connection."
  2. "And here we closed the session = returned the connection to the pool. This is useful if, for example, at the beginning of the handle a database query is needed, and then there is some other long-term work and you don't want to keep the connection opened" -> "We closed the session and returned the connection to the pool" and "Use if you have more work you need to complete without keeping the connection open."
  3. "You don't have to use the context to work with sessions at all" -> "Using the context is option while working with sessions"
  4. "In some situations, you need to have multiple sessions running simultaneously" -> "You may need to run multiple sessions simultaneously"
  5. "transaction will be automatically rolled back" -> "transactions roll back automatically"
  6. "You can manually commit the transaction if you want, but it is not necessary" -> "manually commits the transaction (optional)"
  7. "You can close the session if you want, but it is not necessary" -> "manually closes the session (optional)"

…eferences sections, including the text represnted in code which has been COMMENTED OUT, NOT THE CODE ITSELF
@annibond annibond merged commit 5f67bf6 into main Jan 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants