📚 Fix typos and grammar errors in documentation#1630
Open
Conversation
Co-authored-by: ubmarco <839934+ubmarco@users.noreply.github.com>
Co-authored-by: ubmarco <839934+ubmarco@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve legibility of documentation and fix spelling mistakes
Fix typos and grammar errors in documentation
Jan 22, 2026
ubmarco
approved these changes
Jan 22, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1630 +/- ##
==========================================
+ Coverage 86.87% 88.37% +1.49%
==========================================
Files 56 70 +14
Lines 6532 9937 +3405
==========================================
+ Hits 5675 8782 +3107
- Misses 857 1155 +298
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Documentation contained spelling mistakes, grammar errors, and formatting issues affecting readability.
Changes
Fixed 7 errors across documentation files:
Spelling
availble→available(configuration.rst)nd interference→and interference(tutorial.rst)Grammar
A need objects...it's→A need object...its(directives/need.rst)we can also different fields→we can also display different fields(tutorial.rst)can be become→can become(filter.rst)Word choice
passionated→passionate(support.rst)Formatting
Housekeeping
venv/to .gitignoreWarning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
docs.python.org/home/REDACTED/work/sphinx-needs/sphinx-needs/.tox/docs-furo/bin/sphinx-build /home/REDACTED/work/sphinx-needs/sphinx-needs/.tox/docs-furo/bin/sphinx-build -nW --keep-going -b html docs/ docs/_build/html/furo -T(dns block)https://api.github.com/search/issues/home/REDACTED/work/sphinx-needs/sphinx-needs/.tox/docs-furo/bin/sphinx-build /home/REDACTED/work/sphinx-needs/sphinx-needs/.tox/docs-furo/bin/sphinx-build -nW --keep-going -b html docs/ docs/_build/html/furo -T(http block)www.sphinx-doc.org/home/REDACTED/work/sphinx-needs/sphinx-needs/.tox/docs-furo/bin/sphinx-build /home/REDACTED/work/sphinx-needs/sphinx-needs/.tox/docs-furo/bin/sphinx-build -nW --keep-going -b html docs/ docs/_build/html/furo -T(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.