fix: correct InterpreterCallerMeta.desc doc comment and 'feild' typos - #270
Open
thedavidmeister wants to merge 1 commit into
Open
fix: correct InterpreterCallerMeta.desc doc comment and 'feild' typos#270thedavidmeister wants to merge 1 commit into
thedavidmeister wants to merge 1 commit into
Conversation
Closes #196. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Warning Review limit reachedNext included review available in 23 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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.
Closes #196.
InterpreterCallerMeta.desccarried a copy-paste ofabi_name's doc comment —"Name of the caller corresponding to
contractNamefeild in the abi." — whichdescribes
abi_name, not a free-text description field. Both comments spelled"field" as "feild".
These doc comments are consumer-visible, not only rustdoc:
schema_for!incrates/cli/src/cli/schema/show.rsemits them as thedescriptionof eachproperty in the JSON schema that
rain-metadata schema showprints forinterpreter-caller-v1.abi_name: typo fix only, the comment was already accurate for the field itis on.
desc: replaced with a description of the field it is on, in the same shapeas the sibling
aliascomment ("Alias of the caller used by Rainlang.").Doc-only. No behaviour, validation or wire-format change; no test touched.
Relation to the other in-flight work on this file
Four other open issues target
crates/cli/src/meta/types/interpreter_caller/v1.rs.None overlaps these two lines, and none blocks or is blocked by this:
Method.expressionspermits an empty array. PR fix: require at least one expression per InterpreterCallerMeta method #240 (open) adds#[validate(length(min = 1))]on theMethodstruct.TryFrom<RainMetaDocumentV1Item>ignoresitem.magic. PR gate OpMeta and InterpreterCallerMeta item conversions on magic #242(open, closes OpMeta and InterpreterCallerMeta TryFrom<RainMetaDocumentV1Item> accept items of any magic #165) adds the magic gate inside that impl block.
context_columnsu8::MAXcap and the unboundedContextColumn.cellsaxis, both awaiting a domain ruling; no PR yet. Theyland on the
Expression/ContextColumnstructs.This PR touches only the two doc-comment lines inside the
InterpreterCallerMetastruct, so it merges cleanly with all four in any order.
QA
the suite asserts these strings (
grep -rn "Name of the caller corresponding\|feild"matched only the two lines changed), and a doc comment is not observable to a
Rust test; its only consumer surface is
schema showoutput and rustdoc. Atest that pinned the prose would pin the thing being corrected, not behaviour.
pub desc: Descriptionwith
#[serde(default)], aRainStringfree-text field, against a commentsaying "Name of the caller corresponding to
contractName", which is verbatimthe comment on
abi_name: SolidityIdentifierthree lines above. Thereplacement's shape comes from the sibling
aliascomment, not from the codeunder change.
desc's comment describes a different field,(b)
feildtypo on thedesccomment, (c)feildtypo on theabi_namecomment. Covered a, b, c — and
grep -rn feildover the repo now returnsnothing, so no other instance was left behind.
Also run under
nix develop:cargo test -p rain-metadata --lib interpreter_caller— 19 passed, 0 failed;
cargo fmt --check -p rain-metadata— clean. The fullsuite was not run locally by request.
🤖 Generated with Claude Code