Our great sponsors
-
Have a look at https://github.com/grafana/loki for example. Based on it and the source for Kubectl, my team has adopted gRPC, and two libs called Cobra and Viper by https://github.com/spf13
-
Please fellow Rubyists, document your methods with YARDoc tags. It takes a few seconds, makes your code easier to navigate, and causes you to double-check your interfaces. You can even document abstract methods (ex: @abstract), method groups (ex: @group), named examples (ex: @example Title here, code below), public/semipublic/private APIs (ex: @api public|semipublic|private), when a method/class/module was added (ex: @since 1.2.0), documenting keyword argument splats (ex: @option kwargs [Integer] :count), and when a method can accept any type of Object that responds to a specific method (ex: @param [#foo] arg).
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
Take a look at any of my ruby libraries, they all have YARD docs (ex: wordlist. The .document (specifies additional files to include), .yardopts (other command-line opts), and Rakefile (defines the yard rake task) are the main files you'll want to edit to configure things. As for CI integration, yard-junk has a rake task that can be ran in CI. Writing tag-based documentation is much nicer. You just annotate the arguments, yield params, return type, any raised exceptions. If you change the API then you should update the docs as well, as well as any tests.
-
You may want to keep an eye on Crystal. It has all of the benefits of Go, with Ruby syntax and core classes, macros, Generics, etc. It just doesn't have the talent pool that Go or Ruby has, but if you know Ruby you can easily learn Crystal.
