docs: Improved clarity and formatting within documentation #2033

feteu · 2025-02-09T10:13:15Z

Fixes #2032.

Changes proposed in this pull request:

Improved clarity and formatting in CLI documentation
Enhanced documentation for context variables and ASGI scope
Refined language and clarity in the Connexion Cookbook
Fixed grammar, punctuation, and typos in multiple .rst and .md files, including:
- index.rst
- lifespan.rst
- middleware.rst
- quickstart.rst
- request.rst
- response.rst
- security.rst
- swagger_ui.rst
- testing.rst
- v3.rst
- validation.rst
- README.md

These updates enhance readability and maintain consistency across the documentation.

…t.rst`

docs/index.rst

docs/lifespan.rst

docs/security.rst

docs/testing.rst

docs/validation.rst

chrisinmtown

This PR cleans up many small documentation problems and I recommend merging it. I added a couple tiny comments. Please note I'm a fellow user, not a maintainer.

…lidating"

feteu · 2025-07-12T10:29:06Z

@chrisinmtown thanks for taking the time to quickly go over the adjustments. I've fixed most of the suggestions.

feteu · 2025-07-12T10:30:16Z

@Ruwann is this ready to go or do you have any objections?

docs/context.rst

feteu added 18 commits February 9, 2025 10:57

Improve clarity and formatting in CLI documentation

6c6f125

Enhance documentation for context variables and ASGI scope in `contex…

10f109f

…t.rst`

Refine language and clarity in the Connexion Cookbook documentation

4ba80b2

Fix grammar and punctuation in exceptions documentation

6e2d64a

Improve clarity and language in index.rst documentation

4686ca8

Improve clarity and language in lifespan.rst documentation

db92269

Improve clarity and language in middleware.rst documentation

0c2e1c9

Fix grammar and punctuation in quickstart.rst documentation

2c82c7a

Fix grammar and punctuation in request.rst documentation

b846f14

Fix grammar and punctuation in response.rst documentation

1d6062d

Fix typo in routing.rst documentation

d4afe02

Fix grammar and capitalization in security.rst documentation

0197b48

Fix grammar and punctuation in swagger_ui.rst documentation

568419b

Fix grammar and punctuation in testing.rst documentation

3e76bf2

Fix typo in v3.rst documentation

2f5df62

Fix grammar in validation.rst documentation

0238d62

Fix typo in README.md documentation

b1eeea3

Fix capitalization in code block syntax in README.md

61c29fd

feteu mentioned this pull request Feb 18, 2025

docs: Documentation Cleanup and Consistency Improvements #2032

Open