-
-
Notifications
You must be signed in to change notification settings - Fork 199
Document the process of skipping/ignoring/opting-out of an individual hook function #842
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
base: main
Are you sure you want to change the base?
Conversation
WalkthroughAdds documentation clarifying that individual extension hook functions can be opted out. One file inserts a reference in the Hooks section pointing to opt-out guidance; the other adds a new section explaining how maintainers can unset specific hook functions (using the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Comment |
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: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/Developer-Guide_Extensions-Hooks.md(1 hunks)docs/Developer-Guide_Extensions.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/Developer-Guide_Extensions.md
105-105: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
|
@coderabbitai Please provide suggestions on eliminating the use of 2nd-person pronouns. |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 1603 @tabrisnet, I've identified two instances of 2nd-person pronouns ("your") in the new documentation section. Here are my suggestions for eliminating them: Current text with 2nd-person pronouns:Line 1: Doing so is at your [the board/family maintainer's] own risk and doing so is officially unsupported.Suggested revision: Doing so is at the board/family maintainer's own risk and is officially unsupported.Line 2: Consider splitting the function into pieces so that only the part your board cannot tolerate is skipped.Suggested revision (Option 1): Consider splitting the function into pieces so that only the part the board cannot tolerate is skipped.Suggested revision (Option 2): Consider splitting the function into pieces so that only incompatible parts are skipped.Suggested revision (Option 3): Consider splitting the function into pieces so that only intolerable parts are skipped.Complete rewritten section:# Opt-out of individual hook functions
Any function making use of the extension framework [generally of the form `hook_name__individual_function`] can be skipped in a board or family config, by way of
unset -f hook_name__individual function These changes maintain the technical accuracy and meaning while using 3rd-person references instead of 2nd-person pronouns. |
02c51f3 to
4010d9e
Compare
related to armbian/build#8897