-
Notifications
You must be signed in to change notification settings - Fork 842
Docs: Fix environment checker output descriptions #46486
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
Conversation
Match the actual output format of tools/check-development-environment.sh: - quick-start.md: Change "YES or OK" to "ok or yes", "NO" to "no" - development-environment.md: Change "SUCCESS" to "ok or yes", "FAILED" to "no"
|
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖 Follow this PR Review Process:
If you have questions about anything, reach out in #jetpack-developers for guidance! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR fixes documentation inaccuracies in the environment checker output descriptions. The actual tools/check-development-environment.sh script uses lowercase messages (ok, yes, no), but the documentation incorrectly referenced uppercase variations (YES, OK, NO, SUCCESS, FAILED).
- Updated message references from uppercase to lowercase to match actual script output
- Applied changes consistently across both quick-start and development-environment documentation files
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/quick-start.md | Changed YES or OK to ok or yes and NO to no in environment checker output descriptions |
| docs/development-environment.md | Changed SUCCESS to ok or yes and FAILED to no in environment checker output descriptions, also fixed grammar from "detect" to "detects" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Fixes #
Proposed changes:
The actual output of
tools/check-development-environment.shuses lowercaseok,yes, andno.Other information:
Jetpack product discussion
N/A - Documentation fix
Does this pull request change what data or activity we track or use?
No
Testing instructions:
tools/check-development-environment.shand verify the output uses lowercaseok,yes, andno