Remove OP_BATCHER_THROTTLE_INTERVAL #1420
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes update the batcher configuration documentation by correcting a spelling error and clarifying the throttling options. Specifically, the description for the Possibly related PRs
Suggested reviewers
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
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pages/operators/chain-operators/configuration/batcher.mdx (1)
1-5: Missing Required Metadata in FrontmatterThe frontmatter currently includes only the title, language, and description. According to the documentation guidelines for regular pages, additional metadata fields such as
topic,personas,categories, andcontent_typeshould be present and non-empty. Please update the frontmatter accordingly.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/configuration/batcher.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/configuration/batcher.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (2)
pages/operators/chain-operators/configuration/batcher.mdx (2)
117-117: Updated Introduction for Throttling FlagsThe new introductory sentence—"The batcher can be configured with the following new flags and default parameters:"—clearly prepares the reader for the list of configuration options. This update appropriately aligns with the removal of the
OP_BATCHER_THROTTLE_INTERVALparameter.
119-120: Clarification on Throttle ThresholdThe revised bullet for the throttle-threshold flag now clearly explains that a backlog value of 1,000,000 enables throttling and that setting this flag to
0disables throttling. This change fulfills the objective of removing references toOP_BATCHER_THROTTLE_INTERVALand streamlines the explanation about controlling throttling viaOP_BATCHER_THROTTLE_THRESHOLD.
|
Is it worth calling out that the way the config works changed in release We could have a little box that describes the old behaviour, and keep that around until we are sure everyone will have updated? |
Removes mentions of
OP_BATCHER_THROTTLE_INTERVALand instead recommends alteringOP_BATCHER_THROTTLE_THRESHOLDwhen one wants to disable throttling