utopia-project icon indicating copy to clipboard operation
utopia-project copied to clipboard

Yeah, it should be YARD. It doesn't really now the `@attribute` directive. It has `@!attribute`, which is for attributes created with meta-programming.

Open ioquatix opened this issue 7 months ago • 0 comments

          Yeah, it should be YARD. It doesn't really now the `@attribute` directive. It has `@!attribute`, which is for attributes created with meta-programming.

I usually document normal attributes like this:

      # @return [Messaging::Handlers::Base]
      attr_reader :messaging

It's not very intuitive. Oh well.

Utopia looks very nice but what I miss are superclasses (https://github.com/socketry/utopia-project/issues/3), inherited methods, and private methods. It just makes a quick reading of a method's implementation that much more comprehensible.

Originally posted by @paddor in https://github.com/socketry/async/issues/326#issuecomment-2229523313

ioquatix avatar Jul 19 '24 01:07 ioquatix