TIL https://gemdocs.org/ is a viable alternative to https://rubydoc.info (currently down). Also supports YARD docs and seems fairly fast.
#ruby #docs #yard #yardoc

Anyone here able to give a good overview of the differences in capabilities between YARD and RBS beyond the fact that the two store types in different places? I know both have type checkers but I’m curious to know if RBS would have the same ability to document types as YARD or if one can cover more situations than the other. #yardoc #ruby #rbs

Anyone got any good recommendations for getting started with improving #yardoc documentation within an existing project?

Been trying to see what people recommend online but most of what I have found has been more tutorials on YARD itself than how to actually develop a system for monitoring and increasing the level of documentation within a product using a systematic approach.

#ruby #yardoc #documentation #softwaredevelopment

@noelrap How do you feel people should work towards increasing this YARD documentation?

I've been pushing for this type of documentation for this reason, and since a lot of people I know seem opposed to the idea of having a separate type file, it seems like the best middle ground at the moment, particularly when a lot of projects already have some form of YARD documentation.

Unfortunately the biggest hurdle I see atm is that in fast moving software it can be hard to reach that stage where there is enough documentation and awareness that people commit to using and updating YARD documentation, particularly when you also have external contributors who might not be familiar with those standards.

Curious to hear what your thoughts are on this :)

#ruby #yardoc

@postmodern

If I'm understanding the issue you're encountering, the `[attach]` macro clause is supposed to do this. However, I've never gotten it to work properly.

My issue with this has been slightly different; I want the *declaration* of the class method to have its own docco, describing what it does, but _also_ have the `[attach]` functionality to provide a boilerplate so each use of it documents the attributes it's declaring.
#tuby #YARD #yardoc

How do YARDoc users document calls to DSL methods that are called within another block in a class, and are defined in another gem? Example:

```
class MyClass < OtherGem::DSL

setup do
define_some_method :foo, type: String
end
end
```

Do I really have to manually type out @!method macros for each defined reader/writer or is there some way to do this using @!macro?
#ruby #yard #yardoc