Poetry documentation proofread

[deronnax]

Pull Request Check List

No issue number. Documentation-only changes.
Most of them were suggested to me by the Grazzie spelling and grammar plugin from PyCharm. However, I reviewed them all, and only selected the most relevant. All the changes are broken down in several commits by topics, which makes it so you can accept only some of them if you want to (thouh I would advise to take them all).

Some changes:

• changes some words to american English
• fix some grammar
• fix usage of "an sdist"
• fix some tense and nouns agreement
• add some missing hyphens
• rephrases a somewhat unnatural sentence

Slightly more controversial: add commas where missing. Despite maybe looking sentencious, it helps giving the sentences a clearer structure, breaking them in smaller parts. I think it is particularly usefull to people whose English is not the main language.

Summary by Sourcery

Proofread and improve documentation for Poetry, focusing on grammar, spelling, and clarity across multiple documentation files.

Documentation:

• Perform comprehensive proofreading of Poetry documentation
• Improve grammar and spelling using PyCharm's Grazzie plugin
• Add missing commas and hyphens
• Refine sentence structure for better readability

Chores:

• Standardize American English spelling
• Improve overall documentation consistency

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request focuses on enhancing the Poetry documentation through proofreading and minor corrections. It includes fixes for grammar, tense agreement, and the standardization of language to American English. Additionally, it improves sentence structure and ensures consistency in technical terms.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Corrected minor grammatical errors and improved sentence structure for clarity and readability.	Fixed grammatical errors. Improved sentence structure by adding missing commas. Rephrased sentences for better clarity.	docs/faq.md docs/dependency-specification.md docs/repositories.md docs/pyproject.md docs/libraries.md docs/cli.md docs/contributing.md docs/pre-commit-hooks.md docs/basic-usage.md docs/building-extension-modules.md docs/configuration.md
Standardized language to use American English.	Replaced British English spellings with American English equivalents.	docs/faq.md docs/dependency-specification.md docs/repositories.md docs/pyproject.md docs/libraries.md docs/cli.md docs/contributing.md docs/pre-commit-hooks.md docs/basic-usage.md docs/building-extension-modules.md docs/configuration.md
Improved the consistency and accuracy of technical terms and phrases.	Corrected the usage of 'an sdist'. Ensured proper tense and noun agreement. Added missing hyphens to compound words.	docs/faq.md docs/dependency-specification.md docs/repositories.md docs/pyproject.md docs/libraries.md docs/cli.md docs/contributing.md docs/pre-commit-hooks.md docs/basic-usage.md docs/building-extension-modules.md docs/configuration.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @deronnax - I've reviewed your changes - here's some feedback:

Overall Comments:

• Thanks for improving the documentation, paying attention to grammar and clarity is really important.
• It's great that you've broken down the changes into smaller commits by topic, making it easier to review.

Here's what I looked at during the review

• 🟡 General issues: 3 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[radoering]

Most changes look good to me. Just one thing:

• fix usage of "an sdist"

I think this is wrong because you speak it like "es-dist" (starting with a vowel) and if I remember correctly, the decision between "a" and "an" depends on the pronouncation - not how it is written.

[deronnax]

I checked and you are right (e.g Britannica Dictionary: How do you know whether to use "a" or "an"?
). Reverting this one.

[github-actions]

Deploy preview for website ready!

✅ Preview
https://website-cby18yo0e-python-poetry.vercel.app

Built with commit 15c2476.
This pull request is being automatically deployed with vercel-action