Next-gen ruby libs! » github.com/dry-rb » website: https://dry-rb.org » forum: https://discourse.dry-rb.org
@cored pls ask questions about usage / support on discourse.dry-rb.org
Hi, does someone have some good patterns for documenting input/output of operations from dry-transaction?
Atm I'm doing something like this:
# Creates adjustment for order
#
# @param [Hash] input input for operation
# @option input [Order] :order !!document this
# @option input [Adjustable] :adjustable !!document this
# @option input [Boolean] :included !!document this
#
# @return [Dry::Monads::Either::Right, Dry::Monads::Either::Left, #success?, #failure?, #value]
#but i'm not sure if it's clear enough for users. What do you think?
looks like that in yard
dry-structs are not supposed to be used for sophisticated nested scenarios ?
@flash-gordon :D arrays of hashes of hashes of arrays of hashes ... or even number :)
well, nested structures are supported, including arrays. Can't say I have such examples in my project though, this really depends on your case (performance requirements for instance)
@flash-gordon , i don't expect performance issues here - trying to play with it for input/output contracts... just read "Struct classes quack like dry-types"