Update miner.recommit default
#1296
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the documentation for the Assessment against linked issues
The changes fully address the requirements specified in issue #1295, updating both the documentation text and example to reflect the recommended Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
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/builders/node-operators/configuration/execution-config.mdx (1)
1213-1214: Consider varying the sentence structure in the examples.The tab labels could be rewritten to avoid repetition at the beginning of each line.
- <Tabs.Tab>`--miner.recommit=100ms`</Tabs.Tab> - <Tabs.Tab>`GETH_MINER_RECOMMIT=100ms`</Tabs.Tab> + <Tabs.Tab>Example: `--miner.recommit=100ms`</Tabs.Tab> + <Tabs.Tab>Environment: `GETH_MINER_RECOMMIT=100ms`</Tabs.Tab>🧰 Tools
🪛 LanguageTool
[style] ~1213-~1213: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Tabs.Tab>--miner.recommit=100ms</Tabs.Tab> <Tabs.Tab>`GETH_MINER_RECOMMIT=100ms...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/builders/node-operators/configuration/execution-config.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/node-operators/configuration/execution-config.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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.
"
🪛 LanguageTool
pages/builders/node-operators/configuration/execution-config.mdx
[style] ~1213-~1213: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Tabs.Tab>--miner.recommit=100ms</Tabs.Tab> <Tabs.Tab>`GETH_MINER_RECOMMIT=100ms...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/builders/node-operators/configuration/execution-config.mdx (1)
1209-1214: LGTM! The documentation update accurately reflects the new default value.The change from 2 seconds to 100 milliseconds for the block recreation interval is properly documented in both the description and examples.
🧰 Tools
🪛 LanguageTool
[style] ~1213-~1213: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...Tabs.Tab>--miner.recommit=100ms</Tabs.Tab> <Tabs.Tab>`GETH_MINER_RECOMMIT=100ms...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
…optimism/docs into bradleycamacho-patch-1
Closes #1295