docs: fix typos in comments, docstrings and an error message - #841
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
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
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.
Description
Fixes 10 spelling and grammar mistakes in Python comments, docstrings and one user-facing API error message. Contributing guide asks that PRs have "no spelling mistakes", so this cleans up some existing ones.
No behaviour changes, no identifiers renamed, no tests affected.
Scope note:
accross->acrossinrun_metric.pywas not in the original list I was working from - I added it because it sits two words aftertahtyon the same line, and correcting one while walking past the other would have looked arbitrary. It is the only occurrence ofaccrossin the repository. Everything else below was identified up front.web/api/maestro_api/db/repo/run_metric.py
Stores reusable queries over metrics tahty can be reused accross the project->that can be reused across the project(two misspellings on the one line)Group metrics by passed amout of seconds->amount of seconds# Counts should be devided by interval->divided by intervalweb/api/maestro_api/services/auth/authorization.py
algorithms (list): Argorythms used for decoding->Algorithms used for decoding{"description": "The token as expired"}->"The token has expired"(this string is returned to API clients on an expired JWT; it appears nowhere else in the repo, so no test assertions needed updating)web/api/maestro_api/controllers/run.py
"Get Single Run run by ID"->"Get Single Run by ID"(duplicated word; this docstring is the endpoint's description)Run itself is fully independant instance->independent instanceagent/maestro_agent/services/jmeter/properties.py
Build dict of properties based on overrideds priorities->override priorities# The value can be overriden by using environment variable->overriddenagent/maestro_agent/services/docker.py
# We need to configure SHH client properly->SSH clientDependencies
None.
Checklist
docs:)