chore: typo fix - Githubissues

arrow1991 commented 2 weeks ago

What's the purpose of this PR

typo fix

Which issue(s) this PR fixes:

Fixes #

Brief changelog

typo fix

Follow this checklist to help us incorporate your contribution quickly and easily:

[✅] Read the Contributing Guide before making this pull request.
[✅] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
[✅] Write necessary unit tests to verify the code.
[❌ ] Run mvn clean test to make sure this pull request doesn't break anything.
[❌ ] Update the CHANGES log.

Summary by CodeRabbit

Documentation
- Enhanced clarity and detail in the Apollo client user guides, including new sections on access keys and error code descriptions.
- Expanded descriptions of HTTP interfaces for configuration retrieval in both English and Chinese guides.
Bug Fixes
- Corrected typographical errors in comments across various scripts and configuration files for improved readability.
Refactor
- Improved variable naming for clarity in the PortalOpenApiConfig class.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

This pull request includes various changes across multiple files, primarily focusing on minor corrections in comments, variable renaming for clarity, and enhancements to documentation. Specifically, the pom.xml file had a comment corrected, while the PortalOpenApiConfig class saw variable name updates. Documentation improvements were made to user guides in both English and Chinese, detailing configuration services and access keys. Additionally, a script was updated for clarity in comments without altering its functionality.

Changes

File	Change Summary
apollo-common/pom.xml	Corrected comment from "Micrometer core dependecy" to "Micrometer core dependency."
apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/PortalOpenApiConfig.java	Renamed variables: `tomcatRelaxedpathcharsProperty` to `tomcatRelaxedPathCharsProperty` and `tomcatRelaxedquerycharsProperty` to `tomcatRelaxedQueryCharsProperty`.
docs/en/client/other-language-client-user-guide.md	Enhanced clarity and detail about Apollo configuration service, added sections on access keys and error codes, and refined HTTP interface descriptions.
docs/zh/client/other-language-client-user-guide.md	Similar enhancements as the English user guide, focusing on clarity regarding supported clients and configuration retrieval.
scripts/openapi/bash/openapi-usage-example.sh	Corrected typographical errors in comments, such as "varialbes" to "variables."
scripts/openapi/bash/openapi.sh	Minor comment correction in the `item_update_create_if_not_exists` function for grammatical accuracy.

Possibly related PRs

#5227: Introduces a limit on the number of configuration items per namespace, related to configuration management.
#5240: Addresses the visibility of items in the namespace panel, relevant to the management of configuration items.
#5249: Enhances the OpenAPI by allowing control over item information retrieval, relating to configuration management.
#5264: Introduces a value length limit function for AppId-level configuration items, directly related to configuration management.

🐰 "In the land of code where changes bloom,
A comment fixed to chase away gloom.
Variables renamed for clarity's delight,
Documentation shines, making knowledge bright.
With each little tweak, the project grows,
A hop, a skip, where improvement flows!" 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 2 weeks ago

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅