Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

docs: Require American spelling in documentation #8207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 22, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: Require American spelling in documentation
It's the standard spelling choice in Python, Django, JavaScript, CSS and
most of Django CMS's codebase itself
  • Loading branch information
Thiago Chaves de Oliveira Horta committed Apr 26, 2025
commit a28cce25ebcc6235b76d8193ddfbe5aa83b87ac7
2 changes: 1 addition & 1 deletion 2 docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@
# extensions.append("sphinxcontrib.spelling")

# Spelling language.
spelling_lang = 'en_GB'
spelling_lang = 'en_US'

# Location of word list.
spelling_word_list_filename = 'spelling_wordlist'
Expand Down
6 changes: 3 additions & 3 deletions 6 docs/contributing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Documentation should be:
- written using valid Sphinx_/restructuredText_ syntax (see below for specifics); the
file extension should be ``.rst``
- wrapped at 100 characters per line
- written in English, using British English spelling and punctuation
- written in English, using American English spelling and punctuation
- accessible - you should assume the reader to be moderately familiar with Python and
Django, but not anything else. Link to documentation of libraries you use, for
example, even if they are "obvious" to you
Expand Down Expand Up @@ -135,8 +135,8 @@ You need to check your spelling before submitting documentation.

.. important::

We use British English rather than US English spellings. This means that we use
*colour* rather than *color*, *emphasise* rather than *emphasize* and so on.
Prefer American English spelling, as it is the standard used in Python, Django,
JavaScript, CSS and Django CMS.

Install the spelling software
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading
Morty Proxy This is a proxified and sanitized view of the page, visit original site.