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

chore: typo fix #5272

Merged
merged 1 commit into from
Nov 5, 2024
Merged

chore: typo fix #5272

merged 1 commit into from
Nov 5, 2024

Conversation

arrow1991
Copy link
Contributor

@arrow1991 arrow1991 commented Nov 4, 2024

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.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Nov 4, 2024
Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

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

🐰 "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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Nov 4, 2024

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

@arrow1991
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
docs/zh/client/other-language-client-user-guide.md (1)

120-120: Improve reliability of internal document link.

The current URL-encoded link fragment might not work consistently across different Markdown renderers. Consider using a simpler anchor format.

Replace the complex encoded link with a simpler anchor:

-7. 如果返回的HttpStatus是200,说明配置有变化,针对变化的namespace重新去服务端拉取配置,参见[1.3 通过不带缓存的Http接口从Apollo读取配置](#_13-%E9%80%9A%E8%BF%87%E4%B8%8D%E5%B8%A6%E7%BC%93%E5%AD%98%E7%9A%84http%E6%8E%A5%E5%8F%A3%E4%BB%8Eapollo%E8%AF%BB%E5%8F%96%E9%85%8D%E7%BD%AE)。同时更新notifications map中的notificationId。重新执行第1步。
+7. 如果返回的HttpStatus是200,说明配置有变化,针对变化的namespace重新去服务端拉取配置,参见[1.3 通过不带缓存的Http接口从Apollo读取配置](#13)。同时更新notifications map中的notificationId。重新执行第1步。

Then add this anchor above section 1.3:

<a id="13"></a>
## 1.3 通过不带缓存的Http接口从Apollo读取配置
🧰 Tools
🪛 Markdownlint

120-120: null
Link fragments should be valid

(MD051, link-fragments)

docs/en/client/other-language-client-user-guide.md (1)

132-132: LGTM with a minor formatting suggestion.

The added step provides valuable information about handling configuration changes when receiving a 200 status code. However, there's a minor formatting inconsistency in the step numbering - step 7 appears to be indented differently than the previous steps.

Consider adjusting the indentation to match the previous steps for better readability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2b31ac6 and a532ba1.

📒 Files selected for processing (6)
  • apollo-common/pom.xml (1 hunks)
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/PortalOpenApiConfig.java (1 hunks)
  • docs/en/client/other-language-client-user-guide.md (1 hunks)
  • docs/zh/client/other-language-client-user-guide.md (1 hunks)
  • scripts/openapi/bash/openapi-usage-example.sh (2 hunks)
  • scripts/openapi/bash/openapi.sh (1 hunks)
✅ Files skipped from review due to trivial changes (4)
  • apollo-common/pom.xml
  • apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/PortalOpenApiConfig.java
  • scripts/openapi/bash/openapi-usage-example.sh
  • scripts/openapi/bash/openapi.sh
🧰 Additional context used
🪛 Markdownlint
docs/zh/client/other-language-client-user-guide.md

120-120: null
Link fragments should be valid

(MD051, link-fragments)

🔇 Additional comments (1)
docs/en/client/other-language-client-user-guide.md (1)

132-132: PR description doesn't match the nature of changes.

While the PR is labeled as a "typo fix", this change actually adds missing documentation about handling HTTP 200 status codes in the configuration update push logic. Consider updating the PR description to accurately reflect the nature of the change as a documentation enhancement rather than a typo fix.

Let's verify if there are any other documentation improvements or actual typo fixes in this PR:

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Nov 5, 2024
@hezhangjian hezhangjian changed the title typo fix chore: typo fix Nov 5, 2024
@hezhangjian hezhangjian merged commit 0cba391 into apolloconfig:master Nov 5, 2024
12 of 13 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Nov 5, 2024
@nobodyiam nobodyiam added this to the 2.4.0 milestone Jan 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants