Xeme: I'd value your opinion on my new Ruby gem

• xeme

  1 0 4.7 Ruby

  Xeme - general purpose format for reporting results.

My gem is on GitHub and on RubyGems. I'd value any opinions the community has.

• YARD

  18 1,905 6.9 Ruby

  YARD is a Ruby Documentation tool. The Y stands for "Yay!"

In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.

• WorkOS

  workos.com sponsored

  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.

  

• RDoc

  8 819 8.8 Ruby

  RDoc produces HTML and online documentation for Ruby projects.

  

In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.

• rubocop

  39 12,491 9.8 Ruby

  A Ruby static code analyzer and formatter, based on the community Ruby style guide.

  

But I will encourage you to adopt Rubocop to enforce the style you want, so that if others want to contribute, they can write with spaces and then run rubocop -a and end up with the styling you prefer. Tabs indentation support was added a couple of years back: https://github.com/rubocop/rubocop/pull/7867

• rubydoc.info

  6 132 5.3 Ruby

  Next generation rdoc.info site

  

GitHub will render markdown (and other formats), but I don't believe it supports parsing and rendering YARD or RDoc. Both tools ship with tools that generate documentation websites that you can use for your project. YARD also has https://rubydoc.info

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

Suggest a related project