Repository navigation
refactor(runtime): put conditionText's doc comment back on conditionText - #1499
Merged
Merged
Conversation
Co-Authored-By: jason.han <hanhuijun@gmail.com>
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
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.
What and why
conditionText's doc comment ("conditionText renders a condition compactly…") sat directly abovequalifiedNameText's own doc comment ininternal/exec/runtime/condition.go, so godoc and readers attributed it toqualifiedNameTextwhileconditionTextitself had no doc comment. This moves the two lines back ontofunc conditionText. Comment-only; no code changes. The exportedConditionTextforwarder stays, as it is the package API used byinternal/translate/codegen/compile.go.How it was verified
go build ./...— cleango vet ./...— cleangofmt -l .— prints nothingpython3 scripts/changelog.py check— passesgo test ./...— 115 packagesok;cmd/sysml,internal/exec/runtime,internal/exec/smt,tests/codegen,tests/export,tests/modelandtests/wasmhit Go's default 10 m package timeout under the parallel run, then re-run alone with-count=1 -timeout 60m:cmd/sysmlok 545.7sinternal/exec/runtimeok 329.8sinternal/exec/smtok 346.5stests/codegenok 409.2stests/exportok 156.2stests/modelok 149.0stests/wasmok 91.5sChecklist
go build ./...,go vet ./...,gofmt -l .andgo test ./...pass locally (results above);make lintnot run for a comment-only movechanges/unreleased/condition-text-doc-comment.changed.md, not as an edit toCHANGELOG.mdmake docs-countsrun if a gate count moved — no count movedF4,K5) in the body, docs, or changelogLink to Devin session: https://nasa-jpl-demo.devinenterprise.com/sessions/38a2f421daf54106a0f52b2061900daa
Open in Devin Desktop: https://nasa-jpl-demo.devinenterprise.com/desktop/session/38a2f421daf54106a0f52b2061900daa?variant=devin
Requested by: @HuiJun