Repository navigation
Fix typos and grammar in protocol docstrings - #75
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
Corrects eight documentation-only issues in the AerospikeReadOps/WriteOps, ClientEvents and UserKey docstrings and in the vectorize docstring. No code or behaviour changes.
This branch has not been deployed
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
1 participant
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.
Summary
Fixes 8 documentation-only typos/grammar issues in docstrings:
. the:binskey->. The:binskey(sentence start)`index` should be string->`index` should be a stringto uses the non-default policy->to use the non-default policystored under at `index`->stored under `index`(duplicated preposition)when operations succeeds->when the operation succeedswhen operations fails->when the operation failsa ready made key->a ready-made keyso vectorize them is not allowed->so vectorizing them is not allowedNo functional changes - docstrings only. No version bump, per CONTRIBUTING.md's rule against unrelated changes.
Note for maintainers: the parameter name
as-namesapce(misspelling ofas-namespace) appears inAerospikeIndex/create-key-methodin protocols.clj and throughout key.clj. That is an identifier rename with a potential (if small) API-surface impact, so it is deliberately left out of this docs-only PR.