docs(htmx): add request_class to example

[yujinyuz]

Description

This just adds the request_class into the example provided in the htmx section. I was just following the example and encountered an error.

Closes

#3723

[Alc-Alc]

Thank you for your contribution 🙂

I am afraid you must have overlooked this. As shown in https://docs.litestar.dev/latest/usage/htmx.html#htmxrequest, request_class=HTMXRequest is set at the app layer and hence is not needed to be specified at any other layers.

app = Litestar(
    route_handlers=[get_form],
    debug=True,
    request_class=HTMXRequest,
    template_config=TemplateConfig(
        directory=Path("litestar_htmx/templates"),
        engine=JinjaTemplateEngine,
    ),
)

In place of your current suggestion, maybe a line (or two) that signifies this can be added?

[JacobCoffee]

as @Alc-Alc mentioned

[yujinyuz]

@JacobCoffee @Alc-Alc

Are you suggesting like a comment within the code that the request_class can be added or should I put it somewhere else within the htmx docs?

[Alc-Alc]

@JacobCoffee @Alc-Alc

Are you suggesting like a comment within the code that the request_class can be added or should I put it somewhere else within the htmx docs?

Heya @yujinyuz, I am suggesting the following

A special :class:`~litestar.connection.Request` class, providing interaction with the
HTMX client. For a request to be considered an :class:`~litestar.contrib.htmx.request.HTMXRequest`, set ``request_class=HTMXRequest``
at a preferred layer (app / router / controller / handler).

over here

litestar/docs/usage/htmx.rst

Lines 6 to 10 in 47c09ff

	HTMXRequest
	------------
	A special :class:`~litestar.connection.Request` class, providing interaction with the
	HTMX client.

Feel free to rephrase or even rework that sentence, my suggestion is for the intent to be clear. The intent being, "add request_class=HTMXRequest at some layer for this to work".

@JacobCoffee FYI.

[github-actions]

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3725

[cofin]

There are some updates coming to the HTMX documentation in this PR #3837

Before I'd seen this, I updated the verbiage slightly to say you can add the request_class at any level of the app. Feel free to re-open with changes based on those updates that include the plugin.