Skip to content

Update documentation: Add adrf third party package#9198

Merged
lovelydinosaur merged 1 commit intoencode:masterfrom
mj026:add-adrf-third-party-package
Jun 24, 2024
Merged

Update documentation: Add adrf third party package#9198
lovelydinosaur merged 1 commit intoencode:masterfrom
mj026:add-adrf-third-party-package

Conversation

@mj026
Copy link
Copy Markdown

@mj026 mj026 commented Dec 19, 2023

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

auvipy
auvipy reviewed Dec 19, 2023
View reviewed changes
Copy link
Copy Markdown
Collaborator

@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

@mj026 mj026 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
Merged
@lovelydinosaur
Copy link
Copy Markdown
Contributor

lovelydinosaur commented Apr 8, 2024

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.

@mj026
Copy link
Copy Markdown
Author

mj026 commented Jun 24, 2024

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

@lovelydinosaur lovelydinosaur merged commit 7297f19 into encode:master Jun 24, 2024
@browniebroke browniebroke added this to the 3.16 milestone Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@auvipy auvipy auvipy left review comments

@lovelydinosaur lovelydinosaur lovelydinosaur approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

3.16

Development

Successfully merging this pull request may close these issues.

4 participants

@mj026 @lovelydinosaur @auvipy @browniebroke