Skip to content

Commit

Permalink
misc docs tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Archmonger committed Sep 24, 2023
1 parent 376f7b7 commit 0eb6e90
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Using the following categories, list your changes in this order:
### Deprecated

- The `compatibility` argument on `reactpy_django.components.view_to_component` is deprecated. Use `reactpy_django.components.view_to_iframe` instead.
- Using `reactpy_django.components.view_to_component` as a `#!python @decorator` is deprecated. Check the docs on the new suggested usage.
- Using `reactpy_django.components.view_to_component` as a decorator is deprecated. Check the docs on the new suggested usage.

## [3.5.1] - 2023-09-07

Expand Down
6 changes: 3 additions & 3 deletions docs/src/reference/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ We supply some pre-designed that components can be used to help simplify develop

Automatically convert a Django view into a component.

At this time, this component works best with static views that do not rely on HTTP methods other than `GET`.
At this time, this works best with static views that do not rely on HTTP methods other than `GET`.

Compatible with [Function Based Views](https://docs.djangoproject.com/en/dev/topics/http/views/) and [Class Based Views](https://docs.djangoproject.com/en/dev/topics/class-based-views/). These views can be sync or async.
Compatible with sync or async [Function Based Views](https://docs.djangoproject.com/en/dev/topics/http/views/) and [Class Based Views](https://docs.djangoproject.com/en/dev/topics/class-based-views/).

=== "components.py"

Expand Down Expand Up @@ -142,7 +142,7 @@ Automatically convert a Django view into an [`iframe` element](https://www.techt

The contents of this `#!python iframe` is handled entirely by traditional Django view rendering. While this solution is compatible with more views than `#!python view_to_component`, it comes with different limitations.

Compatible with [Function Based Views](https://docs.djangoproject.com/en/dev/topics/http/views/) and [Class Based Views](https://docs.djangoproject.com/en/dev/topics/class-based-views/). These views can be sync or async.
Compatible with sync or async [Function Based Views](https://docs.djangoproject.com/en/dev/topics/http/views/) and [Class Based Views](https://docs.djangoproject.com/en/dev/topics/class-based-views/).

!!! Warning "Pitfall"

Expand Down

0 comments on commit 0eb6e90

Please sign in to comment.