Skip to content

Document extra_debug in the docs#6461

Open
snejus wants to merge 1 commit intomasterfrom
fix-extra-debug-changelog-note
Open

Document extra_debug in the docs#6461
snejus wants to merge 1 commit intomasterfrom
fix-extra-debug-changelog-note

Conversation

@snejus
Copy link
Member

@snejus snejus commented Mar 23, 2026

Document extra_debug Logging Method for Plugin Authors

What Changed

Two docs are updated to describe the BeetsLogger.extra_debug method, which was previously undocumented for external plugin authors and the changelog note is updated accordingly.

@snejus snejus requested a review from a team as a code owner March 23, 2026 14:38
Copilot AI review requested due to automatic review settings March 23, 2026 14:38
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

PR add docs for BeetsLogger.extra_debug so plugin author know how to log very noisy debug without spamming normal -v/-vv.

Changes:

  • Document self._log.extra_debug(...) in plugin logging docs.
  • Update changelog entry to point at BeetsLogger.extra_debug and explain verbosity -vvv behavior.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/dev/plugins/other/logging.rst Add short guidance for plugin authors to use extra_debug for very noisy diagnostics.
docs/changelog.rst Refresh changelog note to mention BeetsLogger.extra_debug and its verbosity gating.

Update changelog and plugin logging docs to describe the new
`BeetsLogger.extra_debug` method, which emits DEBUG messages only
at verbosity level 3 or higher (-vvv).
@snejus snejus force-pushed the fix-extra-debug-changelog-note branch from 793a6f4 to d362bf5 Compare March 23, 2026 19:16
@snejus snejus requested a review from Copilot March 23, 2026 19:16
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants