Skip to content

Conversation

theletterf
Copy link
Contributor

@theletterf theletterf commented Apr 10, 2025

As per our writing guidelines:

In most cases, please is unnecessary.

This PR removes almost all instances of "Please", rewriting the sentences when necessary. I only kept "please" in sample error messages or logs.

Note: I don't usually open PRs this big, but I wanted to run a sweep to get a feeling of the docs repo.

@theletterf theletterf added the documentation Improvements or additions to documentation label Apr 10, 2025
@theletterf theletterf self-assigned this Apr 10, 2025
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@jmikell821 jmikell821 left a comment

Choose a reason for hiding this comment

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

Thanks @theletterf! There are 71 references where we use see. Per our accessibility guidelines, this can be considered an ableist term, but is a hard habit to break! We should try to replace these with refer to, check out, etc. By no means your fault, so we can clean these up in a subsequent PR if needed.

@theletterf
Copy link
Contributor Author

Thanks @jmikell821 ! Will open a PR for instances of "See" soon!

@theletterf theletterf requested a review from jmikell821 April 10, 2025 16:39
@theletterf theletterf merged commit 9ae2220 into main Apr 10, 2025
4 checks passed
@theletterf theletterf deleted the theletterf-remove-please-instances branch April 10, 2025 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants