Skip to content

Conversation

@tabrisnet
Copy link
Contributor

related to armbian/build#8897

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2025

Walkthrough

Adds 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 hook_name__individual_function naming convention and unset -f) and includes disclaimers about risk and lack of official support. No code or runtime behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Changes are purely documentation across two files.
  • Review focus: wording accuracy, clarity, examples, and internal links.
  • Files to check:
    • docs/Developer-Guide_Extensions-Hooks.md
    • docs/Developer-Guide_Extensions.md

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: documenting how to skip/opt-out of individual hook functions, which aligns with the documentation additions in both files.
Description check ✅ Passed The description references a related issue (armbian/build#8897) and is relevant to the changeset, though brief. It indicates the PR is about documenting the hook opt-out process.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 02c51f3 and 4010d9e.

📒 Files selected for processing (2)
  • docs/Developer-Guide_Extensions-Hooks.md (1 hunks)
  • docs/Developer-Guide_Extensions.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/Developer-Guide_Extensions.md
  • docs/Developer-Guide_Extensions-Hooks.md

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added Needs review Seeking for review size/small PR with less then 50 lines labels Nov 12, 2025
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: 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 966b97e and f0d3a40.

📒 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)

@tabrisnet
Copy link
Contributor Author

@coderabbitai Please provide suggestions on eliminating the use of 2nd-person pronouns.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 12, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the diff for this PR
gh pr diff 842 --repo armbian/documentation

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


Doing so is at the board/family maintainer's own risk and is officially unsupported. Consider splitting the function into pieces so that only the part the board cannot tolerate is skipped.

These changes maintain the technical accuracy and meaning while using 3rd-person references instead of 2nd-person pronouns.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs review Seeking for review size/small PR with less then 50 lines

Development

Successfully merging this pull request may close these issues.

1 participant