Skip to content

docs(backlog): fix stale error() level wording in backlog index - #142

Merged
FullGas1 merged 1 commit into
developfrom
fix/backlog-readme-error-level-wording
Aug 26, 2026
Merged

docs(backlog): fix stale error() level wording in backlog index#142
FullGas1 merged 1 commit into
developfrom
fix/backlog-readme-error-level-wording

Conversation

@FullGas1

@FullGas1 FullGas1 commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • The .backlog/README.md index entry for FIX-CONFIG-NOT-LOADED-GUARD still described the guard as using error(msg, 3). That was the initial implementation, but review remediation on PR fix(config): refuse getSetting() before ctld.initialize(), clearly #141 changed it to error(msg, 0) (message-only) because a fixed stack level breaks for real tail-call call sites in Lua 5.1.
  • Doc-only fix: one wording correction in the index line, no code change.

Test plan

  • Doc-only change, no tests affected.

Summary by Sourcery

Documentation:

  • Correct the backlog index wording to accurately describe the merged configuration-not-loaded guard behavior.

… index entry

The index line still described error(msg, 3); the fix landed as
error(msg, 0) after review remediation on PR #141 (tail calls break
a fixed stack level in Lua 5.1).
@FullGas1
FullGas1 requested a review from davidp57 as a code owner August 26, 2026 20:49
@sourcery-ai

sourcery-ai Bot commented Aug 26, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the backlog index documentation for FIX-CONFIG-NOT-LOADED-GUARD to match the merged implementation, changing the stale error(msg, 3) wording to error(msg, 0) and noting the Lua 5.1 tail-call rationale; no production code or tests are affected.

File-Level Changes

Change Details Files
Correct the backlog index to document the guard’s current message-only error behavior and explain why a fixed stack level is not used.
  • Replace error(msg, 3) with error(msg, 0).
  • Clarify that fixed stack levels fail for real tail-call sites in Lua 5.1.
.backlog/README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@FullGas1
FullGas1 merged commit f537f00 into develop Aug 26, 2026
8 checks passed
@FullGas1
FullGas1 deleted the fix/backlog-readme-error-level-wording branch August 26, 2026 20:51
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