-
Notifications
You must be signed in to change notification settings - Fork 515
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
🎨 fix typos #2898
🎨 fix typos #2898
Conversation
a7c1fb7
to
53cdedd
Compare
Looks like a regen of the openapi and swagger json files is necessary after merging #2899 🙂 |
Signed-off-by: ff137 <[email protected]>
Signed-off-by: ff137 <[email protected]>
Signed-off-by: ff137 <[email protected]>
Signed-off-by: ff137 <[email protected]>
Quality Gate passedIssues Measures |
@@ -64,7 +64,7 @@ async def _resolve( | |||
return doc | |||
|
|||
async def create_and_store(self, profile: Profile, peer2: str): | |||
"""Injest did:peer:2 create did:peer:3 and store document.""" | |||
"""Inject did:peer:2 create did:peer:3 and store document.""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"""Inject did:peer:2 create did:peer:3 and store document.""" | |
"""Ingest did:peer:2 create did:peer:3 and store document.""" |
This one might actually be meant to be "ingest," from the context; i.e. taking in a did:peer:2, creating a did:peer:3, and storing a document.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ingest was my first guess 😄 but then I doubted myself when I noticed that "inject" is also just 1 character away. Plus, inject is less gastrointestinal.
If ingest makes more sense, I'll amend that 👌
The other funny one was "encluding", which was the hardest to correct 😂 both "including" and "excluding" are just a 1 character diff. So that's another one I'd appreciate confirmation that I guessed right 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's probably clear enough as it is 🙂 The wording in general on this one is a bit odd
The most minor of quality of life improvements.
The motivation was to fix typos that appear in the openapi spec, because typos in the model descriptions would propagate to autogenerated clients.
Fixing those, I would 'find all' to fix all instances in the codebase. So at first it was just to fix typos in model descriptions, and that expanded to more parts.
When I started correcting double spaces, that's when I knew I'd gone too far.
Using the Code Spell Checker vscode extension made this pretty straightforward. Can recommend.
No external model names or anything changed, so no breaking changes as a result of corrections. Just internal variable names, comments, and some readme improvements.
Edit: I also modified model descriptions to no longer contain \n characters or excessive whitespace, and committed the updated openapi specs, to reflect the changes there as well.
Edit2: Went a bit above and beyond to correct typos in more modules. Lots of files changed, I know... but a scanning review should just take a couple minutes!