Jacob Walls
259b28706e
Fixed some broken links and redirects in docs.
2021-08-09 07:07:52 +02:00
David Smith
fbb1984046
Refs #32956 -- Updated words ending in -wards.
...
AP styleguide: Virtually none of the words ending with -wards end with
an s.
2021-07-30 20:34:50 +02:00
David Smith
1024b5e74a
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
David Smith
1cba320786
Refs #32956 -- Changed "afterwards" to "afterward" in docs and comments.
...
This also removes unnecessary comments with the previous spelling.
AP Stylebook has a short entry to advise the preferred spelling for
"en-us". "Afterwards" is preferred in British English.
2021-07-27 10:41:51 +02:00
ᴙɘɘᴙgYmɘᴙɘj
5838102ae6
Fixed typo in docs/internals/contributing/committing-code.txt.
2021-07-14 20:21:26 +02:00
Chris Jerdonek
90ba716bf0
Fixed #24522 -- Added a --shuffle option to DiscoverRunner.
2021-07-08 07:29:04 +02:00
Mariusz Felisiak
f10c52afab
Refs #31356 -- Changed IRC links to the Libera.Chat webchat.
...
Follow up to 66491f08fe
.
2021-06-03 12:07:30 +02:00
Jacob Walls
f0d0d29f03
Fixed typos in docs.
2021-06-03 07:49:50 +02:00
Jacob Walls
1443b5e9ac
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.
2021-06-02 08:14:57 +02:00
Mariusz Felisiak
66491f08fe
Changed IRC references to Libera.Chat.
2021-05-20 12:23:36 +02:00
Nick Pope
0851933cba
Fixed #32720 -- Added configuration and docs for Sphinx link checker.
...
We explicitly ignore checking anchors for line-range anchors on GitHub
which are dynamically generated and, otherwise, show up as broken links.
See https://github.com/sphinx-doc/sphinx/issues/7388#issuecomment-739961689 .
We also ignore links to resources that require authentication.
2021-05-17 11:21:35 +02:00
Nick Pope
c156e36955
Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS.
2021-05-17 09:46:09 +02:00
Nick Pope
c240ceea7d
Fixed typo in docs/internals/contributing/writing-documentation.txt.
2021-05-06 20:01:32 +02:00
Hasan Ramezani
ca34db4650
Refs #32178 -- Doc'd DatabaseFeatures.django_test_skips/django_test_expected_failures in contributing guide.
2021-04-29 20:55:34 +02:00
Carlton Gibson
e3e2276e6f
Fixed #32652 -- Fixed links to new contributors FAQ.
2021-04-15 17:14:22 +02:00
Carlton Gibson
5aea50e57f
Updated asgiref dependency for 3.2 release series.
2021-04-06 10:38:43 +02:00
Mariusz Felisiak
98d3fd6102
Updated link to Selenium webdrivers.
2021-03-09 11:29:54 +01:00
Markus Holtermann
d9a266d657
Updated Git branch "master" to "main".
...
This change follows a long discussion on django-develops:
https://groups.google.com/g/django-developers/c/tctDuKUGosc/
2021-03-09 08:48:32 +01:00
GabbyPrecious
ead9085f08
Refs #32412 -- Adjusted Contributing Guide start page.
...
* Added headers emphasising Work on the framework vs Join the community
sections, to raise the visibility of the community section.
* Added callouts to three main code/docs/translations areas, linking to
respective start pages.
* Moved some Writing code specific content from the start page to the
Writing code index. This clarifies the start page and adds content to the
previously empty Writing code index.
Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2021-03-03 15:34:06 +01:00
Mariusz Felisiak
ec0ff40631
Fixed #32355 -- Dropped support for Python 3.6 and 3.7
2021-02-10 10:20:54 +01:00
Carlton Gibson
e48e78738e
Corrected typo in advice to new contributors.
2021-02-04 16:00:47 +01:00
GabbyPrecious
e733c9ac17
Refs #32412 -- Adjusted beginning of Advice for new contributors.
...
With the goal of guiding folks to the right destination:
* Improved wording of tutorial call-out.
* Added summary of page purpose.
* Added link to Writing code reference doc.
2021-02-04 10:33:16 +01:00
hashlash
4794a0e35f
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.
2021-01-09 20:18:00 +01:00
Jon Dufresne
429d089d0a
Refs #30367 -- Changed remaining "pip install" to "python -m pip install" in docs.
2020-12-23 17:21:25 +01:00
David Smith
3bca95cca2
Fixed #32165 -- Added pre-commit hooks
...
* Added pre-commit hooks for isort, flake8 and eslint
* Added documentation on how to install and use the tool
2020-12-23 11:14:48 +01:00
Jon Dufresne
28d998a41c
Updated isort URL to new location.
2020-12-20 11:00:28 +01:00
Nick Pope
477c800443
Changed docs and a code comment to use gender-neutral pronouns.
...
Follow up to e1b7723817
.
2020-11-13 22:26:30 +01:00
MinchinWeb
f1585c54d0
Fixed #31216 -- Added support for colorama terminal colors on Windows.
...
Modern setups on Windows support terminal colors.
The colorama library may also be used, as an
alternative to the ANSICON library.
2020-11-11 14:27:10 +01:00
Carlton Gibson
411cc0ae18
Fixed #29988 -- Updated coding style to allow f-strings.
...
Thanks to Nick Pope for review.
2020-10-15 10:09:34 +02:00
David Smith
e74b3d724e
Bumped minimum isort version to 5.1.0.
...
Fixed inner imports per isort 5.
isort 5.0.0 to 5.1.0 was unstable.
2020-07-30 10:58:59 +02:00
Mariusz Felisiak
3d16496037
Bumped asgiref requirement to >= 3.2.10.
...
Forwardported 3.1 release notes from 474f65406f
.
2020-07-17 21:15:21 +02:00
Adam Johnson
2afa61e7d9
Refs #31493 -- Replaced var with const/let in documentation JS.
2020-06-24 12:20:57 +02:00
Florian Apolloner
faad809e09
Refs #30472 -- Simplified Argon2PasswordHasher with argon2-cffi 19.1+ API.
2020-06-17 08:10:41 +02:00
David Smith
7514852767
Removed redundant pyenchant dependency in spelling check docs.
2020-06-01 07:07:56 +02:00
Jon Dufresne
81ffedaacc
Fixed #31524 -- Removed minified static assets from the admin.
2020-05-14 16:07:56 +02:00
Nick Pope
fbdb032de2
Used :envvar: role and .. envvar:: directive in various docs.
2020-05-13 09:14:40 +02:00
Nick Pope
feb91dbda1
Used :mimetype: role in various docs.
2020-05-13 09:14:04 +02:00
Nick Pope
a9337b4add
Used :pep: role in various docs.
2020-05-13 09:14:04 +02:00
Adam Johnson
d17b380653
Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and comments.
2020-05-04 12:10:47 +02:00
Hasan Ramezani
33f7739108
Fixed #31356 -- Changed IRC links to the Freenode webchat.
2020-04-29 20:08:36 +02:00
Jon Dufresne
f48a1990fb
Made compress.py script use the official google-closure-compiler release.
...
The script previously used the PyPI package closure, which is slightly
out of date and not maintained by Google.
The JavaScript contribution docs and the compress.py script now runs the
google-closure-compiler package in the recommended way. Google's
documentation on usage and installation can be found at:
https://github.com/google/closure-compiler-npm/tree/master/packages/google-closure-compiler#usage
This also makes the usage simpler as the package now runs through npm's
npx utility, which will automatically install google-closure-compiler to
a per-user cache.
2020-04-22 16:19:27 +02:00
Jignesh Kotadiya
7b4bd2a82c
Refs #22463 -- Replaced JSHint with ESLint in contributing docs.
2020-04-20 10:53:00 +02:00
Mariusz Felisiak
cc70a0343e
Fixed term warning on Sphinx 3.0.1+.
...
"term" role became case sensitive in Sphinx 3.0.1.
2020-04-14 09:32:09 +02:00
Adam Johnson
1cdfe8d912
Prevented (and corrected) single backtick usage in docs.
2020-04-01 14:55:11 +02:00
Takuya Noguchi
c25a8c77d7
Fixed #31241 -- Clarified porting translations of the Django docs to docs.djangoproject.com.
2020-02-12 08:41:48 +01:00
Vibhu Agarwal
6f9ecc23f6
Fixed #31226 -- Fixed typo in docs/internals/contributing/writing-code/submitting-patches.txt.
2020-02-03 20:16:06 +01:00
Vibhu Agarwal
1a09708dcb
Fixed #31222 -- Fixed typo in docs/internals/contributing/bugs-and-features.txt.
2020-02-03 11:02:58 +01:00
Mariusz Felisiak
0ac8ac8b0d
Refs #25778 -- Updated some links to HTTPS and new locations.
2020-01-29 09:34:37 +01:00
Jon Dufresne
32166a9f7c
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
Mads Jensen
ea44d86ed4
Added guidelines for assertIs() usage.
2019-12-30 11:25:18 +01:00
Jon Dufresne
5708327c37
Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin.
...
Unify on the entry point created by setuptools entry_points feature.
2019-12-06 12:11:44 +01:00
Hasan Ramezani
b1d39131eb
Fixed typo in internals/contributing/writing-documentation.txt.
2019-12-03 20:11:54 +01:00
Baptiste Mispelon
42df1b178b
Refs #31029 -- Added note about :rfc: role in writing documentation docs.
2019-11-27 20:52:28 +01:00
Carlton Gibson
36453526d3
Pinned asgiref version.
2019-11-20 14:57:08 +01:00
Stephen Rauch
4b6db766ba
Refs #30183 -- Doc'd dropping support for sqlparse < 0.2.2.
...
Support for sqlparse < 0.2.2 was broken in
782d85b6df
because is_whitespace property
was added in sqlparse 0.2.2.
2019-11-06 08:45:43 +01:00
André Ericson
54a7b02112
Fixed #30927 -- Simplified an example of test for the deprecation warning with assertWarnsMessage().
2019-10-30 13:35:36 +01:00
Mariusz Felisiak
2a54ce72f9
Added tblib to the list of test suite dependencies in documentation.
2019-10-23 15:26:04 +02:00
Mariusz Felisiak
e10ebf43e1
Bumped minimum Pillow version to 6.2.0 in test requirements.
...
Pillow < 6.2.0 is vulnerable to CVE-2019-16865.
2019-10-23 15:07:06 +02:00
Carlton Gibson
adfd920cc5
Moved "Sign the CLA" to the bottom of New Contributor First Steps.
...
As discussed on the mailing list, step 1 of First Steps shouldn't be
"Find a printer".
https://groups.google.com/d/topic/django-developers/owOqFmxufgs/discussion
2019-10-15 14:10:35 +02:00
Graham Healy
90abdba086
Fixed #30808 -- Added the Django Forum to contributing index.
2019-10-15 08:32:37 +02:00
Kees Hink
5d9cf79baf
Fixed #27086 -- Doc'd fix for test suite hang on macOS.
2019-10-09 15:46:44 +02:00
Carlton Gibson
06e087c3de
Added note to check Python version in unit tests troubleshooting section.
...
At DjangoCon US 2019 sprints, a number of contributors hit problems with an outdated Python.
2019-10-09 15:46:44 +02:00
Carlton Gibson
b39c39e82a
Corrected section indentation in unit tests contributor docs.
2019-10-09 15:46:44 +02:00
Katherine Michel
f7eb9fb676
Refs #30010 -- Doc'd running tests with django-docker-box.
2019-10-02 13:43:47 +02:00
Tobias Kunze
4a954cfd11
Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
...
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:
- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous
Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
2019-09-06 13:27:46 +02:00
Mariusz Felisiak
053ff7e9e6
Fixed typo in docs/internals/contributing/writing-documentation.txt.
2019-09-05 14:06:46 +02:00
Carlton Gibson
ed2d411aa8
Refs #30573 -- Noted to avoid "simple" & co. in Writing Style guide.
...
Co-authored-by: Tobias Kunze <r@rixx.de>
2019-09-05 10:13:31 +02:00
Min ho Kim
3c6a4fdb6d
Changed example git clone URLs to use HTTPS.
2019-09-04 08:11:22 +02:00
Andrew Godwin
a415ce70be
Fixed #30451 -- Added ASGI handler and coroutine-safety.
...
This adds an ASGI handler, asgi.py file for the default project layout,
a few async utilities and adds async-safety to many parts of Django.
2019-06-20 12:29:43 +02:00
Hasan Ramezani
e2de49ec2e
Fixed #28520 -- Added --start-at/--start-after options to runtests.py.
2019-05-31 07:01:12 +02:00
Johannes Hoppe
8d010f3986
Fixed #30220 -- Added support for headless mode in selenium tests.
2019-05-17 08:14:54 +02:00
Jon Dufresne
97d3321e89
Changed tuple choices to list in docs.
2019-05-15 14:31:42 +02:00
Ramiro Morales
25b5eea8cd
Fixed #30387 -- Enhanced docs CLI examples in Unit tests and Install Django on Windows.
...
Follow up to 37c17846ad
.
2019-04-23 09:32:55 +02:00
Ville Skyttä
34a68c2cbe
Fixed typo in docs/internals/contributing/committing-code.txt.
2019-04-21 12:47:33 +02:00
Ramiro Morales
aed89adad5
Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints.
2019-04-18 14:41:15 +02:00
Tim Graham
9caa3e0a29
Doc'd a few contributing guidelines.
2019-03-25 18:26:23 -04:00
Tim Graham
7e6b214ed3
Fixed #30116 -- Dropped support for Python 3.5.
2019-01-30 10:19:48 -05:00
Tom Forbes
c8720e7696
Fixed #27685 -- Added watchman support to the autoreloader.
...
Removed support for pyinotify (refs #9722 ).
2019-01-13 20:33:47 -05:00
Mads Jensen
961f8e9985
Updated some links to https and new locations.
2018-11-10 17:40:50 -05:00
Tim Graham
f82be9ebc7
Fixed #29934 -- Added sqlparse as a require dependency.
2018-11-09 19:09:36 -05:00
Mice Pápai
5a2dd5ec53
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.
2018-11-02 15:59:12 +01:00
Jon Dufresne
82f286cf6f
Refs #29784 -- Switched to https:// links where available.
2018-09-26 08:48:47 +02:00
Jon Dufresne
8c3e0eb1c1
Normalized spelling of "lowercase" and "lowercased".
2018-09-25 10:30:18 -04:00
Curtis Maloney
c49ea6f591
Refs #20910 -- Replaced snippet directive with code-block.
2018-09-10 13:00:34 -04:00
Maxime Lorant
31407fa3b3
Removed duplicate words in docs.
...
.
2018-07-18 11:24:06 -04:00
Morgan Aubert
704443acac
Fixed #29363 -- Added SimpleTestCase.assertWarnsMessage().
2018-05-09 11:40:28 -04:00
PhrydRhys
5d022eae74
Fixed #29369 -- Mentioned the #django-dev IRC channel in contributing index.
2018-04-28 20:33:53 -04:00
Brett Cannon
64b74804c5
Fixed #29334 -- Updated pypi.python.org URLs to pypi.org.
2018-04-17 20:24:27 -04:00
Tim Graham
3428be3cf9
Updated contributing docs for some latest practices.
2018-04-06 20:46:06 -04:00
Tim Graham
73cb62a331
Fixed links to Sphinx docs.
2018-03-30 14:29:23 -04:00
Daniel Chimeno
fbb9358149
Replaced 'python -Wall' with 'python -Wa'.
2018-03-28 13:25:03 -04:00
Roy Zwambag
fe32fe1619
Used console directive in "Writing documentation".
2018-03-07 16:19:22 -05:00
Tim Graham
4775dcb521
Renamed the "Supported versions" label.
2018-01-31 10:17:06 -05:00
Ramiro Morales
37c17846ad
Fixed #28343 -- Add an OS chooser for docs command line examples.
2018-01-20 12:38:48 -05:00
Tim Graham
b902878fd6
Doc'd the latest state of the Jenkins pull request builders.
2018-01-17 08:48:53 -05:00
Mariusz Felisiak
7c81b28ebc
Updated various links in docs to use HTTPS.
2018-01-07 14:28:41 +01:00
weijunji
1ef8b30abe
Fixed #28929 -- Corrected QUnit examples.
2017-12-18 09:49:00 -10:00
Mariusz Felisiak
081e787160
Refs #23919 -- Stopped inheriting from object to define new style classes.
...
Tests and docs complement to cecc079168
.
2017-06-26 10:30:31 -04:00
Tim Graham
c68f5d83c0
Fixed #27655 -- Added some guidelines to the coding style docs.
2017-06-12 15:39:09 -04:00
Claude Paroz
01f658644a
Updated various links in docs to avoid redirects
...
Thanks Tim Graham and Mariusz Felisiak for review and completion.
2017-05-22 19:28:44 +02:00