-
-
Notifications
You must be signed in to change notification settings - Fork 10.2k
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
chore: typo fix #5272
Conversation
WalkthroughThis 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 Changes
Possibly related PRs
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
I have read the CLA Document and I hereby sign the CLA |
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.
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
📒 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:
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:
mvn clean test
to make sure this pull request doesn't break anything.CHANGES
log.Summary by CodeRabbit
PortalOpenApiConfig
class.