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

Add spelling checking to the CI #417

Merged
merged 2 commits into from Oct 19, 2023
Merged

Conversation

daniloegea
Copy link
Collaborator

@daniloegea daniloegea commented Oct 17, 2023

Description

Enables the sphinx spelling checking on the documention.

Checklist

  • Runs make check successfully.
  • Retains 100% code coverage (make check-coverage).
  • New/changed keys in YAML format are documented.
  • (Optional) Adds example YAML for new feature.
  • (Optional) Closes an open bug in Launchpad.

@daniloegea daniloegea force-pushed the spelling_checker_ci branch 4 times, most recently from 8fd03ca to 38fbf08 Compare October 18, 2023 10:08
Add a few more words to the dictionary.

Set language to en_US and silence myst warning.

Add some en_GB words from the CoC to the spelling_wordlist.txt so we
don't need to "fix" it.
@daniloegea daniloegea force-pushed the spelling_checker_ci branch 2 times, most recently from ec68be3 to c4e0280 Compare October 18, 2023 18:30
@daniloegea daniloegea changed the title Spelling checker ci Add spelling checking to the CI Oct 19, 2023
@daniloegea daniloegea marked this pull request as ready for review October 19, 2023 07:52
@daniloegea daniloegea requested a review from slyon October 19, 2023 07:52
Copy link
Collaborator

@slyon slyon left a comment

Choose a reason for hiding this comment

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

Thank you! LGTM.

The Jammy autopkgtest failure seems unrelated (see LP#2037667 for reference)

@slyon slyon merged commit 1aa0974 into canonical:main Oct 19, 2023
27 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants