Skip to content

Navigation Menu

Sign in

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
Loading
from
Open

docs: Require American spelling in documentation #8207

wants to merge 1 commit into from

Conversation

shundread
Copy link
Contributor

@shundread shundread commented Apr 26, 2025 •
edited
Loading

It's the standard spelling choice in python, django, JavaScript, CSS and most of django-cms's codebase itself

Description

Sticking to British English spelling in documentation would force people to write sentences such as:

To change the colour scheme use the CMS_COLOR_SCHEME setting in your project’s setting.py

Related resources

  • #...
  • #...

Checklist

  • I have opened this pull request against main
  • I have added or modified the tests when changing logic
  • I have followed the conventional commits guidelines to add meaningful information into the changelog
  • I have read the contribution guidelines and I have joined the channel #pr-reviews on our Discord Server to find a “pr review buddy” who is going to review my pull request.

Summary by Sourcery

Build:

  • Update the Sphinx spell checker language setting from British English (en_GB) to American English (en_US).

@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Apr 26, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request updates the documentation build configuration to enforce American English spelling instead of British English.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Update the documentation spelling language setting
  • Change the spelling language from British English ('en_GB') to American English ('en_US')
 docs/conf.py
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

github-actions[bot]
github-actions bot reviewed Apr 26, 2025
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello! Thank you for your contribution! 🎉

As it's your first contribution, be sure to check out the contribution docs.

We invite you to join us on our Discord Server!

Welcome aboard ⛵️!

sourcery-ai[bot]
sourcery-ai bot reviewed Apr 26, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @shundread - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider running the updated spell checker and addressing existing British English spellings in the documentation as part of this change or in a follow-up.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

docs/contributing/documentation.rst Outdated Show resolved Hide resolved
@shundread shundread force-pushed the fix/switch-to-american-english branch 2 times, most recently from 2dfb130 to b5cfb27 Compare April 26, 2025 05:46
@fsbraun
Copy link
Member

fsbraun commented Apr 26, 2025 •
edited
Loading

@shundread Thank you for the pull request!

I will put this on the agenda of the technical committee meeting, since I believe this needs a formal decision.

I see two paths forward:

  • Stay with British spelling and add exceptions for the python key words like CMS_COLOR_SCHEME.
  • Switch to American spelling (like you propose) - including the assessment of the impact on localization.

@marksweb @mj8arrett

docs: Require American spelling in documentation
a28cce2 
It's the standard spelling choice in Python, Django, JavaScript, CSS and
most of Django CMS's codebase itself
@shundread shundread force-pushed the fix/switch-to-american-english branch from b5cfb27 to a28cce2 Compare April 26, 2025 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shundread @fsbraun
Morty Proxy This is a proxified and sanitized view of the page, visit original site.