frontend, common: comment cleanups - #597
Merged
Merged
Conversation
The reasoning they carried -- why codes.Unknown is the wrong code for a request the caller must change, and that wallets back off and retry on it -- is already stated in full in the CHANGELOG entry this branch adds, so nothing is lost by leaving one line at each site. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015DeK7pepamvANHSUUZWBpm
Both comments named a function other than the one they document, so `go doc` and every editor that reads doc comments attributed them to nothing. `GetTaddressTransactions` was still documented as `GetTaddressTxids`, the name it carried before 8c4c83a split the deprecated RPC out into its own wrapper. Its "NB, this method is misnamed" note goes away with the rename: it described `GetTaddressTxids`, which is still deprecated, still present, and still carries that explanation in full -- along with a link to #426 -- on the wrapper 90 lines below. `addBlockActive` was documented as `DarksideAddBlock`, a name that no longer exists anywhere in the tree. Reported in #524 and #526. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015DeK7pepamvANHSUUZWBpm
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.
Two comment-only cleanups for the release. No behavior change;
gofmtclean, full test suite passes.frontend: shorten two comments to one line each— trims the two multi-line comments added by #595 down to one line each. The reasoning they carried, thatcodes.Unknownis the wrong code for a request the caller must change and that wallets back off and retry on it, is already stated in full in the CHANGELOG entry #595 added, so nothing is lost.frontend, common: name the right functions in two doc comments— both comments named a function other than the one they document, sogo docand every editor that reads doc comments attributed them to nothing.GetTaddressTransactionswas still documented asGetTaddressTxids, the name it carried before 8c4c83a split the deprecated RPC into its own wrapper; its "NB, this method is misnamed" note goes away with the rename, since it describedGetTaddressTxids, which is still present and still carries that explanation in full on the wrapper 90 lines below.addBlockActivewas documented asDarksideAddBlock, a name that no longer exists anywhere in the tree.Reported in #524 and #526, both of which conflicted with master and are closed in favor of this.