Skip to content

docs: Light grammar tidying in documentation#360

Merged
pawamoy merged 2 commits intomkdocstrings:mainfrom
lmmx:lmmx/docs-grammar-fixes
Feb 14, 2025
Merged

docs: Light grammar tidying in documentation#360
pawamoy merged 2 commits intomkdocstrings:mainfrom
lmmx:lmmx/docs-grammar-fixes

Conversation

@lmmx
Copy link
Copy Markdown
Contributor

@lmmx lmmx commented Feb 14, 2025

I was taking some notes in Google Docs to "teach myself Griffe" and noticed some blue squiggly underlines (grammar suggestions), then decided if I was going to submit a PR then why not do the whole docs while I'm here :-)

  • Guide and Getting Started were the only ones I 'rewrote for clarity', happy to revert these if you preferred the originals
  • The rest were Google Docs grammar corrections

@pawamoy
Copy link
Copy Markdown
Member

pawamoy commented Feb 14, 2025

Awesome, thank you so much!!

Copy link
Copy Markdown
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I knew I often mess up pluralization but didn't think this much 😂 Thanks again 🚀

@pawamoy pawamoy merged commit 9717739 into mkdocstrings:main Feb 14, 2025
@lmmx lmmx deleted the lmmx/docs-grammar-fixes branch February 14, 2025 23:39
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