Skip to content
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

docs: Change to GB spelling #1051

Merged
merged 2 commits into from
Jul 18, 2024
Merged

docs: Change to GB spelling #1051

merged 2 commits into from
Jul 18, 2024

Conversation

edibotopic
Copy link
Contributor

@edibotopic edibotopic commented Jul 18, 2024

This changes the default spelling in the docs from US to GB.

Spelling was fixed in text elements, such as headers and paragraphs, but was not changed when a US-spelling referred to paths, keywords or GUI element that are defined in the code/app.

Where, for example, a path or keyword needed to include a US-spelling, it was surrounded in backticks to exclude it from the spellcheck. These changes were then applied to other similar elements for consistency, even when they did not contain US-spelling.

UDENG-3525

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.80%. Comparing base (cec1359) to head (1b63b2a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1051   +/-   ##
=======================================
  Coverage   93.80%   93.80%           
=======================================
  Files          79       79           
  Lines        6881     6881           
=======================================
  Hits         6455     6455           
  Misses        416      416           
  Partials       10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- Changes US spellings to GB
- Does not change spellings if they refer to keywords, paths or GUIs
- Encloses elements (such as paths) in backticks to include US spelling
where necessary without triggering spellchecker
Copy link
Member

@didrocks didrocks left a comment

Choose a reason for hiding this comment

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

It's still in draft, but I am assuming it’s ready and the CI pass :)

"enrol*", seriously? I would have never guessed and remember this single l!

Approuving, oh no! :)

@edibotopic edibotopic force-pushed the change-to-GB-spelling branch from 1b63b2a to a0f92f6 Compare July 18, 2024 11:43
@edibotopic
Copy link
Contributor Author

Hey @didrocks --- this is nearly ready. It was in draft on purpose.

I wanted to restore the checks on internal refs because the errors being raised were associated with a US spelling in a dir name, which then had side-effects. I'm restoring the checks because it's the default behaviour and it works fine but it was noisy during editing.

This involve a lot of busy work 😄

I will merge once checks pass again. Thanks!!!

@edibotopic edibotopic marked this pull request as ready for review July 18, 2024 11:52
@edibotopic edibotopic requested a review from a team as a code owner July 18, 2024 11:52
@edibotopic edibotopic merged commit 174ba1c into main Jul 18, 2024
5 checks passed
@edibotopic edibotopic deleted the change-to-GB-spelling branch July 18, 2024 11:52
@edibotopic edibotopic removed the request for review from a team July 18, 2024 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants