docs(miner-guide): fix stale problem counts in output/debug examples - #264
Open
ygd58 wants to merge 1 commit into
Open
docs(miner-guide): fix stale problem counts in output/debug examples#264ygd58 wants to merge 1 commit into
ygd58 wants to merge 1 commit into
Conversation
data/suites/problem_suite_v3.json has 30 problems total (10 product + 10 shop + 10 voucher), matching the '--problem-file' table row above. But the 'Output' example showed '(30 problems)' per category (implying 90 total) and the 'Debugging Failed Problems' example showed [1/90], [2/90], [3/90] — both left over from before the suite was trimmed to 30. Updated both examples to 10 problems/category and /30 total to match the current suite file and the table row.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
data/suites/problem_suite_v3.json(the default--problem-file, documented two lines above as "Problem suite (30 problems)") currently has 30 problems total: 10product+ 10shop+ 10voucher.But the example output right below it showed
(30 problems)for each category, implying 90 total, and the debugging example showed[1/90],[2/90],[3/90]— both left over from an earlier, larger version of the suite.Why
A miner running the harness locally with the default suite gets
[1/30] ... [30/30], not[1/90], and(10 problems)per category, not(30 problems). As written, the examples don't match what you'd actually see, which is confusing when you're comparing your own run's output against the docs.Change
Updated the per-category problem counts (30 → 10) and the debug progress counter (/90 → /30) in the two examples to match the current suite file and the
--problem-filetable row above them. No code touched.