Skip to content

Commit f8209c0

Browse files
slivercn2ygk
andauthored
Use consistent naming for Django REST framework (django-json-api#977)
Co-authored-by: Alan Crosswell <[email protected]>
1 parent 7202f42 commit f8209c0

File tree

8 files changed

+39
-39
lines changed

8 files changed

+39
-39
lines changed

Diff for: CHANGELOG.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
Note that in line with [Django REST Framework policy](http://www.django-rest-framework.org/topics/release-notes/),
8+
Note that in line with [Django REST framework policy](http://www.django-rest-framework.org/topics/release-notes/),
99
any parts of the framework not mentioned in the documentation should generally be considered private API, and may be subject to change.
1010

1111
## [Unreleased]
@@ -103,7 +103,7 @@ This release is not backwards compatible. For easy migration best upgrade first
103103

104104
## [3.2.0] - 2020-08-26
105105

106-
This is the last release supporting Django 1.11, Django 2.1, Django REST Framework 3.10, Django REST Framework 3.11 and Python 3.5.
106+
This is the last release supporting Django 1.11, Django 2.1, Django REST framework 3.10, Django REST framework 3.11 and Python 3.5.
107107

108108
### Added
109109

@@ -171,7 +171,7 @@ This release is not backwards compatible. For easy migration best upgrade first
171171
* Removed support for Python 2.7 and 3.4.
172172
* Removed support for Django Filter 1.1.
173173
* Removed obsolete dependency six.
174-
* Removed support for Django REST Framework <=3.9.
174+
* Removed support for Django REST framework <=3.9.
175175
* Removed support for Django 2.0.
176176
* Removed obsolete mixins `MultipleIDMixin` and `PrefetchForIncludesHelperMixin`
177177
* Removed obsolete settings `JSON_API_FORMAT_KEYS`, `JSON_API_FORMAT_RELATION_KEYS` and
@@ -188,7 +188,7 @@ This release is not backwards compatible. For easy migration best upgrade first
188188

189189
## [2.8.0] - 2019-06-13
190190

191-
This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, Django REST Framework <=3.9 and Django 2.0.
191+
This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, Django REST framework <=3.9 and Django 2.0.
192192

193193
### Added
194194

@@ -265,7 +265,7 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
265265
* Add new pagination classes based on JSON:API query parameter *recommendations*:
266266
* `JsonApiPageNumberPagination` and `JsonApiLimitOffsetPagination`. See [usage docs](docs/usage.md#pagination).
267267
* Add `ReadOnlyModelViewSet` extension with prefetch mixins
268-
* Add support for Django REST Framework 3.8.x
268+
* Add support for Django REST framework 3.8.x
269269
* Introduce `JSON_API_FORMAT_FIELD_NAMES` option replacing `JSON_API_FORMAT_KEYS` but in comparison preserving
270270
values from being formatted as attributes can contain any [json value](http://jsonapi.org/format/#document-resource-object-attributes).
271271
* Allow overwriting of `get_queryset()` in custom `ResourceRelatedField`
@@ -293,13 +293,13 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
293293

294294
### Added
295295

296-
* Add support for Django REST Framework 3.7.x.
296+
* Add support for Django REST framework 3.7.x.
297297
* Add support for Django 2.0.
298298

299299
### Removed
300300

301301
* Drop support for Django 1.8 - 1.10 (EOL)
302-
* Drop support for Django REST Framework < 3.6.3
302+
* Drop support for Django REST framework < 3.6.3
303303
(3.6.3 is the first to support Django 1.11)
304304
* Drop support for Python 3.3 (EOL)
305305

@@ -326,7 +326,7 @@ This is the last release supporting Python 2.7, Python 3.4, Django Filter 1.1, D
326326

327327
### Added
328328

329-
* Add support for Django REST Framework 3.5 and 3.6
329+
* Add support for Django REST framework 3.5 and 3.6
330330
* Add support for Django 1.11
331331
* Add support for Python 3.6
332332

Diff for: README.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
==================================
2-
JSON:API and Django Rest Framework
2+
JSON:API and Django REST framework
33
==================================
44

55
.. image:: https://github.com/django-json-api/django-rest-framework-json-api/workflows/Tests/badge.svg
@@ -18,13 +18,13 @@ JSON:API and Django Rest Framework
1818
Overview
1919
--------
2020

21-
**JSON:API support for Django REST Framework**
21+
**JSON:API support for Django REST framework**
2222

2323
* Documentation: https://django-rest-framework-json-api.readthedocs.org/
2424
* Format specification: http://jsonapi.org/format/
2525

2626

27-
By default, Django REST Framework will produce a response like::
27+
By default, Django REST framework will produce a response like::
2828

2929
{
3030
"count": 20,
@@ -67,13 +67,13 @@ like the following::
6767
Goals
6868
-----
6969

70-
As a Django REST Framework JSON:API (short DJA) we are trying to address following goals:
70+
As a Django REST framework JSON:API (short DJA) we are trying to address following goals:
7171

7272
1. Support the `JSON:API`_ spec to compliance
7373

74-
2. Be as compatible with `Django REST Framework`_ as possible
74+
2. Be as compatible with `Django REST framework`_ as possible
7575

76-
e.g. issues in Django REST Framework should be fixed upstream and not worked around in DJA
76+
e.g. issues in Django REST framework should be fixed upstream and not worked around in DJA
7777

7878
3. Have sane defaults to be as easy to pick up as possible
7979

@@ -82,19 +82,19 @@ As a Django REST Framework JSON:API (short DJA) we are trying to address followi
8282
5. Be performant
8383

8484
.. _JSON:API: http://jsonapi.org
85-
.. _Django REST Framework: https://www.django-rest-framework.org/
85+
.. _Django REST framework: https://www.django-rest-framework.org/
8686

8787
------------
8888
Requirements
8989
------------
9090

9191
1. Python (3.6, 3.7, 3.8, 3.9)
9292
2. Django (2.2, 3.0, 3.1, 3.2)
93-
3. Django REST Framework (3.12)
93+
3. Django REST framework (3.12)
9494

95-
We **highly** recommend and only officially support the latest patch release of each Python, Django and REST Framework series.
95+
We **highly** recommend and only officially support the latest patch release of each Python, Django and REST framework series.
9696

97-
Generally Python and Django series are supported till the official end of life. For Django REST Framework the last two series are supported.
97+
Generally Python and Django series are supported till the official end of life. For Django REST framework the last two series are supported.
9898

9999
------------
100100
Installation
@@ -160,7 +160,7 @@ Usage
160160

161161

162162
``rest_framework_json_api`` assumes you are using class-based views in Django
163-
Rest Framework.
163+
REST framework.
164164

165165

166166
Settings

Diff for: SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Reporting a Vulnerability
44

5-
If you believe you've found something in Django REST Framework JSON:API which has security implications, please **do not raise the issue in a public forum**.
5+
If you believe you've found something in Django REST framework JSON:API which has security implications, please **do not raise the issue in a public forum**.
66

77
Send a description of the issue via email to [[email protected]][security-mail]. The project maintainers will then work with you to resolve any issues where required, prior to any public disclosure.
88

Diff for: docs/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Django REST Framework JSON:API (aka DJA) should be easy to contribute to.
3+
Django REST framework JSON:API (aka DJA) should be easy to contribute to.
44
If anything is unclear about how to contribute,
55
please submit an issue on GitHub so that we can fix it!
66

@@ -11,7 +11,7 @@ if the proposed change makes sense for the project.
1111

1212
### Clone
1313

14-
To start developing on Django REST Framework JSON:API you need to first clone the repository:
14+
To start developing on Django REST framework JSON:API you need to first clone the repository:
1515

1616
git clone https://github.com/django-json-api/django-rest-framework-json-api.git
1717

Diff for: docs/conf.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python3
22
# -*- coding: utf-8 -*-
33
#
4-
# Django REST Framework JSON:API documentation build configuration file, created by
4+
# Django REST framework JSON:API documentation build configuration file, created by
55
# sphinx-quickstart on Fri Jul 24 23:31:15 2015.
66
#
77
# This file is execfile()d with the current directory set to its
@@ -59,10 +59,10 @@
5959
master_doc = "index"
6060

6161
# General information about the project.
62-
project = "Django REST Framework JSON:API"
62+
project = "Django REST framework JSON:API"
6363
year = datetime.date.today().year
64-
copyright = "{}, Django REST Framework JSON:API contributors".format(year)
65-
author = "Django REST Framework JSON:API contributors"
64+
copyright = "{}, Django REST framework JSON:API contributors".format(year)
65+
author = "Django REST framework JSON:API contributors"
6666

6767
# The version info for the project you're documenting, acts as replacement for
6868
# |version| and |release|, also used in various other places throughout the
@@ -244,8 +244,8 @@
244244
(
245245
master_doc,
246246
"DjangoRESTFrameworkJSONAPI.tex",
247-
"Django REST Framework JSON:API Documentation",
248-
"Django REST Framework JSON:API contributors",
247+
"Django REST framework JSON:API Documentation",
248+
"Django REST framework JSON:API contributors",
249249
"manual",
250250
),
251251
]
@@ -279,7 +279,7 @@
279279
(
280280
master_doc,
281281
"djangorestframeworkjsonapi",
282-
"Django REST Framework JSON:API Documentation",
282+
"Django REST framework JSON:API Documentation",
283283
[author],
284284
1,
285285
)
@@ -298,7 +298,7 @@
298298
(
299299
master_doc,
300300
"DjangoRESTFrameworkJSONAPI",
301-
"Django REST Framework JSON:API Documentation",
301+
"Django REST framework JSON:API Documentation",
302302
author,
303303
"DjangoRESTFrameworkJSONAPI",
304304
"One line description of project.",

Diff for: docs/getting-started.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11

22
# Getting Started
33

4-
*Note: this package is named Django REST Framework JSON:API to follow the naming
5-
convention of other Django REST Framework packages. Since that's quite a bit
4+
*Note: this package is named Django REST framework JSON:API to follow the naming
5+
convention of other Django REST framework packages. Since that's quite a bit
66
to say or type this package will be referred to as DJA elsewhere in these docs.*
77

8-
By default, Django REST Framework produces a response like:
8+
By default, Django REST framework produces a response like:
99
``` js
1010
{
1111
"count": 20,
@@ -53,11 +53,11 @@ like the following:
5353

5454
1. Python (3.6, 3.7, 3.8, 3.9)
5555
2. Django (2.2, 3.0, 3.1, 3.2)
56-
3. Django REST Framework (3.12)
56+
3. Django REST framework (3.12)
5757

58-
We **highly** recommend and only officially support the latest patch release of each Python, Django and REST Framework series.
58+
We **highly** recommend and only officially support the latest patch release of each Python, Django and REST framework series.
5959

60-
Generally Python and Django series are supported till the official end of life. For Django REST Framework the last two series are supported.
60+
Generally Python and Django series are supported till the official end of life. For Django REST framework the last two series are supported.
6161

6262
## Installation
6363

Diff for: docs/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. Django REST Framework JSON:API documentation master file, created by
1+
.. Django REST framework JSON:API documentation master file, created by
22
sphinx-quickstart on Fri Jul 24 23:31:15 2015.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Welcome to Django REST Framework JSON:API
6+
Welcome to Django REST framework JSON:API
77
==========================================================
88

99
Contents:

Diff for: rest_framework_json_api/settings.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
This module provides the `json_api_settings` object that is used to access
3-
JSON:API REST framework settings, checking for user settings first, then falling back to
3+
Django REST framework JSON:API settings, checking for user settings first, then falling back to
44
the defaults.
55
"""
66

0 commit comments

Comments
 (0)