🤖: Hi there! TrickBot here with an afternoon #hachybots #BlogReminder. So far today, Trick has made 1 post on his #blog, on a topic like: #idea, #product & #yard
Check it out: https://trickjarrett.com/
#hachybots #BlogReminder #blog #idea #product #YARD
this guy came back today to visit
#TurtleTuesday #photography #turtle #wildlife #yard #garden #herp #reptile
#TurtleTuesday #photography #turtle #wildlife #YARD #garden #herp #reptile
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
Trying to understand how the yard_plugin.rb file and that file only was somehow owned by root on my system in Ruby 3.2.0 while literally every other file installed by rbenv & ruby-build had the correct permissions.
Does the yard_plugin get installed ad-hoc when some commands are run?
If you’re hosting #YARD documentation on #GitHubPages and running into broken links when trying to load _index.html, it might be due to https://github.com/lsegal/yard/issues/1027. You can disable Jekyll altogether by placing a .nojekyll file in the root of your repo: https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/
@postmodern I think I've seen that described in the #YARD #tag #documentation page somewhere — how to add a docstring for something that doesn't exist. `@abstract`, maybe? I've never used it myself.
@postmodern Look into `overload` in the #YARD #tag documentation? That might help.
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
Playing around with sord, and WOW this thing is GOOD at finding missing YARD tags or mispelled Type names. #ruby #yard
https://github.com/AaronC81/sord#readme