Skip to content

Docs: add context to Incoming Request Data section #5888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Silence91169 wants to merge 1 commit into from
Closed

Docs: add context to Incoming Request Data section #5888

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ Blueprint Objects
Incoming Request Data
---------------------

This section describes how to access data sent by the client in an HTTP
request, such as query parameters, form data, JSON payloads, and headers.
Comment on lines +29 to +30
Copy link

Copilot AI Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding consistency with other sections. The 'Sessions' section (lines 59-67) and 'Application Globals' section (lines 151-156) also have introductory paragraphs. However, 'Application Object', 'Blueprint Objects', and 'Response Objects' sections do not. While this addition is helpful, it creates inconsistency. Consider either adding similar introductions to other major sections or ensuring the current style aligns with the documentation's overall approach.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Author

@Silence91169 Silence91169 Jan 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing this out — that’s a fair observation.

My intention was to add a small amount of context in a section that currently
jumps straight into the API reference, similar to how the Sessions and
Application Globals sections provide brief introductions.

Since this is my first contribution, I tried to keep the scope limited to a
single section to avoid larger stylistic changes. That said, I’m happy to
either adjust the wording to better match the existing approach, or add similar
introductory context to other major sections (such as Application Object,
Blueprint Objects, and Response Objects) if that would be preferred.

Please let me know which direction you’d recommend.


.. autoclass:: Request
:members:
:inherited-members:
Expand All @@ -34,7 +37,8 @@ Incoming Request Data
.. data:: request

A proxy to the request data for the current request, an instance of
:class:`.Request`.
:class:`.Request`. This is the primary interface used by view functions
to access incoming request information.

This is only available when a :doc:`request context </appcontext>` is
active.
Expand Down
Loading