Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect Yarn doc: execute can return a Result, not only Hash #4982

Closed
bmulholland opened this issue Jun 11, 2024 · 2 comments · Fixed by #4984
Closed

Incorrect Yarn doc: execute can return a Result, not only Hash #4982

bmulholland opened this issue Jun 11, 2024 · 2 comments · Fixed by #4984

Comments

@bmulholland
Copy link

bmulholland commented Jun 11, 2024

# @return [Array<Hash>] One result per query
says returns array of hashes

But

results[idx] = query.result
means it can also return a Result element

(relevant because these docs are used for some auto-generation of types and editor features, and because it's used for reference in situations like Shopify/rbi-central#250)

@rmosolgo
Copy link
Owner

Thanks for reporting this! I definitely want to generate the best types I can 🍻 Fix in the works at #4984

@bmulholland
Copy link
Author

Awesome -- thanks for the clarity! I've updated the RBI to match over at rbi-central.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants