Skip to content

Commit 4b8b1a7

Browse files
authored
Merge branch 'main' into fix/viewset-actions-mutation-9747
2 parents 7af0e14 + 249fb47 commit 4b8b1a7

File tree

9 files changed

+24
-22
lines changed

9 files changed

+24
-22
lines changed

.pre-commit-config.yaml

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,21 @@ repos:
2424
hooks:
2525
- id: blacken-docs
2626
additional_dependencies:
27-
- black==25.9.0
27+
- black==26.1.0
2828
- repo: https://github.com/codespell-project/codespell
29-
# Configuration for codespell is in .codespellrc
29+
# Configuration for codespell is in pyproject.toml
3030
rev: v2.4.1
3131
hooks:
3232
- id: codespell
33-
args: [
34-
"--builtin", "clear,rare,code,names,en-GB_to_en-US",
35-
"--ignore-words", "codespell-ignore-words.txt",
36-
"--skip", "*.css",
37-
]
38-
exclude: locale|kickstarter-announcement.md|coreapi-0.1.1.js
3933
additional_dependencies:
4034
# python doesn't come with a toml parser prior to 3.11
4135
- "tomli; python_version < '3.11'"
4236
- repo: https://github.com/asottile/pyupgrade
43-
rev: v3.21.0
37+
rev: v3.21.2
4438
hooks:
4539
- id: pyupgrade
4640
args: ["--py310-plus", "--keep-percent-format"]
4741
- repo: https://github.com/tox-dev/pyproject-fmt
48-
rev: v2.11.0
42+
rev: v2.11.1
4943
hooks:
5044
- id: pyproject-fmt

codespell-ignore-words.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@ IAM
44
endcode
55
deque
66
thead
7-
lets
7+
lets
8+
fo
9+
malcom
10+
ser

docs/api-guide/permissions.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,10 @@ Provided they inherit from `rest_framework.permissions.BasePermission`, permissi
138138
return Response(content)
139139

140140
!!! note
141-
Composition of permissions supports `&` (and), `|` (or) and `~` (not) operators.
141+
Composition of permissions supports the `&` (and), `|` (or) and `~` (not) operators, and also allows the use of brackets `(` `)` to group expressions.
142+
143+
Operators follow the same precedence and associativity rules as standard logical operators (`~` highest, then `&`, then `|`).
144+
142145

143146
# API Reference
144147

docs/img/drf-rw-api-root.png

5.66 KB
Loading

docs/img/drf-rw-detail-view.png

32 KB
Loading

docs/img/drf-rw-list-view.png

110 KB
Loading

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ each Python and Django series.
6969

7070
The following packages are optional:
7171

72-
* [PyYAML][pyyaml], [uritemplate][uriteemplate] (5.1+, 3.0.0+) - Schema generation support.
72+
* [PyYAML][pyyaml], [uritemplate][uritemplate] (5.1+, 3.0.0+) - Schema generation support.
7373
* [Markdown][markdown] (3.3.0+) - Markdown support for the browsable API.
7474
* [Pygments][pygments] (2.7.0+) - Add syntax highlighting to Markdown processing.
7575
* [django-filter][django-filter] (1.0.1+) - Filtering support.
@@ -207,7 +207,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
207207
[heroku]: https://www.heroku.com/
208208
[eventbrite]: https://www.eventbrite.co.uk/about/
209209
[pyyaml]: https://pypi.org/project/PyYAML/
210-
[uriteemplate]: https://pypi.org/project/uritemplate/
210+
[uritemplate]: https://pypi.org/project/uritemplate/
211211
[markdown]: https://pypi.org/project/Markdown/
212212
[pygments]: https://pypi.org/project/Pygments/
213213
[django-filter]: https://pypi.org/project/django-filter/

docs/topics/documenting-your-api.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
>
55
> &mdash; Roy Fielding, [REST APIs must be hypertext driven][cite]
66
7-
REST framework provides a range of different choices for documenting your API. The following
8-
is a non-exhaustive list of the most popular ones.
7+
REST framework provides a range of different choices for documenting your API. The following is a non-exhaustive list of some of the most popular options.
98

10-
## Third party packages for OpenAPI support
9+
## Third-party packages for OpenAPI support
10+
11+
REST framework recommends using third-party packages for generating and presenting OpenAPI schemas, as they provide more features and flexibility than the built-in (deprecated) implementation.
1112

1213
### drf-spectacular
1314

@@ -37,9 +38,9 @@ This also translates into a very useful interactive documentation viewer in the
3738

3839
## Built-in OpenAPI schema generation (deprecated)
3940

40-
**Deprecation notice: REST framework's built-in support for generating OpenAPI schemas is
41-
deprecated in favor of 3rd party packages that can provide this functionality instead.
42-
As replacement, we recommend using the [drf-spectacular](#drf-spectacular) package.**
41+
!!! warning
42+
**Deprecation notice:** REST framework's built-in support for generating OpenAPI schemas is deprecated in favor of third-party packages that provide this functionality instead. As a replacement, we recommend using **drf-spectacular**.
43+
4344

4445
There are a number of packages available that allow you to generate HTML
4546
documentation pages from OpenAPI schemas.

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,9 @@ known_first_party = [ "rest_framework", "tests" ]
107107

108108
[tool.codespell]
109109
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
110-
skip = "*/kickstarter-announcement.md,*.js,*.map,*.po"
111-
ignore-words-list = "fo,malcom,ser"
110+
skip = "*/kickstarter-announcement.md,*.js,*.map,*.po,*.css,locale"
111+
ignore-words = "codespell-ignore-words.txt"
112+
builtin = "clear,rare,code,names,en-GB_to_en-US"
112113

113114
[tool.pyproject-fmt]
114115
max_supported_python = "3.14"

0 commit comments

Comments
 (0)