Correct transposed header aliases in documentation - #113
Draft
sapunyangkut wants to merge 1 commit into
Draft
Conversation
Documentation build overview
|
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.
Summary
<headeras the shorthand request-header directive alias>headeras the shorthand response-header directive aliasRoot cause
The narrative documentation transposed the two shorthand aliases. The implementation already defines
<headerfor request headers and>headerfor response headers, and the existing RST test fixture uses those correct forms.Validation
.venv\Scripts\tox.exe r -e py313git diff --check HEAD^..HEADNo new fixture was added because
test/index.rstalready exercises both shorthand directives; this change only corrects their narrative description.AI disclosure
This documentation correction was prepared with OpenAI Codex-assisted automation. I reviewed the diff, checked it against the implementation and existing tests, and reran the validation above before submission.
Fixes #24.