mirror of
https://github.com/django/django.git
synced 2025-10-24 06:06:09 +00:00
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.
This commit is contained in:
committed by
Mariusz Felisiak
parent
addabc492b
commit
4a954cfd11
@@ -201,15 +201,15 @@ documentation:
|
||||
This is because Sphinx will generate proper links for the latter, which
|
||||
greatly helps readers.
|
||||
|
||||
You can prefix the target with a ``~`` (that's a tilde) to get just the
|
||||
"last bit" of that path. So ``:mod:`~django.contrib.auth``` will just
|
||||
You can prefix the target with a ``~`` (that's a tilde) to get only the
|
||||
"last bit" of that path. So ``:mod:`~django.contrib.auth``` will
|
||||
display a link with the title "auth".
|
||||
|
||||
* Use :mod:`~sphinx.ext.intersphinx` to reference Python's and Sphinx'
|
||||
documentation.
|
||||
|
||||
* Add ``.. code-block:: <lang>`` to literal blocks so that they get
|
||||
highlighted. Prefer relying on automatic highlighting simply using ``::``
|
||||
highlighted. Prefer relying on automatic highlighting using ``::``
|
||||
(two colons). This has the benefit that if the code contains some invalid
|
||||
syntax, it won't be highlighted. Adding ``.. code-block:: python``, for
|
||||
example, will force highlighting despite invalid syntax.
|
||||
@@ -383,8 +383,8 @@ If a function, attribute, etc. is added, it's also okay to use a
|
||||
|
||||
An author's middle name.
|
||||
|
||||
We can simply remove the ``.. versionadded:: A.B`` annotation without any
|
||||
indentation changes when the time comes.
|
||||
We can remove the ``.. versionadded:: A.B`` annotation without any indentation
|
||||
changes when the time comes.
|
||||
|
||||
Minimizing images
|
||||
=================
|
||||
|
||||
Reference in New Issue
Block a user