Skip to content

Correct transposed header aliases in documentation - #113

Draft
sapunyangkut wants to merge 1 commit into
sphinx-contrib:mainfrom
sapunyangkut:codex/issue-24-header-alias-docs
Draft

Correct transposed header aliases in documentation#113
sapunyangkut wants to merge 1 commit into
sphinx-contrib:mainfrom
sapunyangkut:codex/issue-24-header-alias-docs

Conversation

@sapunyangkut

Copy link
Copy Markdown

Summary

  • document <header as the shorthand request-header directive alias
  • document >header as the shorthand response-header directive alias
  • add the required changelog entry

Root cause

The narrative documentation transposed the two shorthand aliases. The implementation already defines <header for request headers and >header for response headers, and the existing RST test fixture uses those correct forms.

Validation

  • .venv\Scripts\tox.exe r -e py313
    • Sphinx 9.1.0 HTML build with warnings treated as errors succeeded
    • pytest: 3 passed
  • git diff --check HEAD^..HEAD
  • checked the generated HTML for the corrected request and response alias listings

No new fixture was added because test/index.rst already 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.

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 sphinxcontrib-httpdomain | 🛠️ Build #33590346 | 📁 Comparing ff84ac2 against latest (1d96b0f)

  🔍 Preview build  

1 file changed
± index.html

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.

Request/response header in style of "<header" is transposed from documenation

1 participant