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

Further cleanup of docs spelling #1865

Merged
merged 4 commits into from Apr 13, 2023
Merged

Conversation

freakboy3742
Copy link
Member

The SSL error on macOS was caused because the PyPI name filter was turned on. This made every single one of the 440k names of PyPI packages a valid word in spelling. So... that needs to be turned off.

That removes the need for the SSL instructions in the contribution guide.

It also reveals a bunch of additional spelling problems. The only ones that aren't legitimate are the ones tied to a package name; for those, I've adopted the policy of:

  • If it's being used in a "code" context, use the name as a literal
  • If it's being used in a "text" context, ensure preferred project naming and capitalisation is used.

I've also updated all the links that were raising redirects. Ideally, redirects could be raised as an error, but that doesn't appear to be an option with Sphinx.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@mhsmith mhsmith merged commit 2e271c3 into beeware:main Apr 13, 2023
43 checks passed
@freakboy3742 freakboy3742 deleted the spelling-cleanup branch June 26, 2023 02:17
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.

None yet

2 participants