rmosolgo/graphql-ruby

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

bmulholland opened this issue · 2 comments

bmulholland commented

graphql-ruby/lib/graphql/execution/interpreter.rb

Line 23 in b7551b5

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

But

graphql-ruby/lib/graphql/execution/interpreter.rb

Line 129 in b7551b5

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 commented

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

  • ❤️1
bmulholland commented

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