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

Spell check and updating docs #2380

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Spell check and updating docs #2380

wants to merge 3 commits into from

Conversation

Nbelles
Copy link

@Nbelles Nbelles commented Jan 26, 2025

  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • [~] added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md

I noticed a slight inconsistency in the public docs (the /windows and /apple pages were referenced but not /android) and I figured while I was making this PR that I might as well do a quick spell check across the codebase. Most everything was updating spelling in comments.

There is one actual code change in an integration test (/integration/cli_test.go) that had a string that had a typo in it. That is probably the only thing that could use a pair of eyes from an actual codebase developer to make sure that doesn't break anything.

Thanks!

docs/about/clients.md Outdated Show resolved Hide resolved
@@ -1840,7 +1840,7 @@ func TestPolicyBrokenConfigCommand(t *testing.T) {
{
// This is an unknown action, so it will return an error
// and the config will not be applied.
Action: "acccept",
Action: "accept",
Copy link
Collaborator

@nblock nblock Jan 27, 2025

Choose a reason for hiding this comment

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

The comment above explicitly mentions an "unknown action", please revert this change.

Copy link
Author

Choose a reason for hiding this comment

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

Would it be reasonable to change this for something that isn't explicitly a typo? Maybe something that makes more logical sense for it to not be valid while still passing a spell check search?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds reasonable, yes.

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.

2 participants