Archus Byte · @ArchusByte
77 followers · 479 posts · Server hachyderm.io

This is either going to be brilliant or a disaster. Also that dog - despite that look on his face, and being arguably our best digger, did not help.

#diy #tunnel #YARD #DIG

Last updated 1 year ago

Trick Jarrett · @trick
380 followers · 1041 posts · Server hachyderm.io

🤖: Hi there! TrickBot here with an afternoon . So far today, Trick has made 1 post on his , on a topic like: , &

Check it out: trickjarrett.com/

#hachybots #BlogReminder #blog #idea #product #YARD

Last updated 1 year ago

peachfront · @peachfront
450 followers · 499 posts · Server toot.community
postmodern · @postmodern
1229 followers · 1520 posts · Server ruby.social

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

#ruby #docs #YARD #yardoc

Last updated 1 year ago

olivierlacan · @olivierlacan
706 followers · 768 posts · Server ruby.social

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?

#ruby #YARD

Last updated 2 years ago

peachfront · @peachfront
185 followers · 569 posts · Server toot.community

Terror on the rock table

#spider #YARD

Last updated 2 years ago

mudge · @mudge
52 followers · 24 posts · Server ruby.social

If you’re hosting documentation on and running into broken links when trying to load _index.html, it might be due to github.com/lsegal/yard/issues/. You can disable Jekyll altogether by placing a .nojekyll file in the root of your repo: github.blog/2009-12-29-bypassi

#YARD #githubpages

Last updated 2 years ago

GenghisKen Coar · @GenghisKen
16 followers · 62 posts · Server ruby.social

@postmodern I think I've seen that described in the page somewhere — how to add a docstring for something that doesn't exist. `@abstract`, maybe? I've never used it myself.

#YARD #tag #documentation

Last updated 2 years ago

GenghisKen Coar · @GenghisKen
16 followers · 62 posts · Server ruby.social

@postmodern Look into `overload` in the documentation? That might help.

#YARD #tag

Last updated 2 years ago

GenghisKen Coar · @GenghisKen
16 followers · 62 posts · Server ruby.social

@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

Last updated 2 years ago

postmodern · @postmodern
565 followers · 452 posts · Server ruby.social

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

Last updated 2 years ago

postmodern · @postmodern
565 followers · 452 posts · Server ruby.social

Playing around with sord, and WOW this thing is GOOD at finding missing YARD tags or mispelled Type names.
github.com/AaronC81/sord#readm

#ruby #YARD

Last updated 2 years ago