Conversation
bkmashiro
force-pushed
the
burn/docs/c0s5xn/add-jsdoc-comments-to-emit-helper-functi
branch
from
35e7844 to
faf222c
Compare
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
bkmashiro
deleted the
burn/docs/c0s5xn/add-jsdoc-comments-to-emit-helper-functi
branch
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.
Task
01KNHK34QE044638XCY2C0S5XNDescription
The ~25 internal helper functions in src/emit/index.ts between lines 413-514 (fnNameToPath, qualifiedFunctionRef, humanFunctionName, emitFunctionHeader, formatSourceMarker, watchDispatcherName, watchPrevObjective, throttleDispatcherName, throttleObjective, retryDispatcherName, retryObjective, profilerSafeName, profilerStartPlayer, profilerDeltaPlayer, profilerTotalPlayer, profilerCountPlayer, benchmarkWrapperName, benchmarkStartPlayer, benchmarkDeltaPlayer, profilerStartLines, profilerEndLines, etc.) have no documentation. Add a JSDoc block to each explaining: what it computes, what each parameter represents, and what the return value is used for. Focus especially on the naming convention helpers (watch/throttle/retry/profiler/benchmark) since their relationship to generated Minecraft scoreboard objectives and storage paths is non-obvious.
Changes
Generated by burn-harness