Skip to content

Update documentation: Add adrf third party package #9198

New issue

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

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

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

maerteijn
Copy link
Contributor

Description

Updated documentation: Added adrf as a third party package and updated the API documentation to refer to the async counterparts of:

  • @api_view
  • APIView
  • Serializer
  • ModelSerializer
  • BaseSerializer
  • ListSerializer
  • ViewSet

See also #8496

Copy link
Member

@auvipy auvipy left a comment

Choose a reason for hiding this comment

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

thanks, i need to think about the wording and placing them properly

@maerteijn maerteijn changed the title Update documentation: add adrf third party package Update documentation: Add adrf third party package Dec 20, 2023
@math-a3k math-a3k mentioned this pull request Jan 24, 2024
@tomchristie
Copy link
Member

We should link to adrf, but I'm not convinced we should be doing that in a way that's different to our existing third party packages. (I don't think we have other cases where we're interspersing links to a third party package throughout the docs?)

Perhaps we could just add a section in https://www.django-rest-framework.org/community/third-party-packages/ (?)

# Existing Third Party Packages

...

## Async Support

* adrf - Provides async Views, ViewSets, and Serializers.

## Authentication

...

Optionally it could also be included in one or more of the existing pages "Third Party Packages" sections.

@maerteijn maerteijn force-pushed the add-adrf-third-party-package branch from f4364bc to 3868707 Compare June 24, 2024 08:22
@maerteijn
Copy link
Contributor Author

Updated the PR as suggested by @tomchristie with just a single reference to adrf (on the third party packages page).

@tomchristie tomchristie merged commit 7297f19 into encode:master Jun 24, 2024
7 checks passed
@browniebroke browniebroke added this to the 3.16 milestone Jan 16, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants