How does Humanizer work?

Open
#64 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
ruby
Domain
documentation

Research direction

Locate the Humanizer and RRule classes and read how options such as freq and count are defined and used. Document the expected Humanizer options, why they are needed, and a basic usage example; the work is done when a reader can understand and use Humanizer without inspecting the implementation.

Written by the indexing model from the issue text.

Description

Hello,

First of all thank you so much for such an amazing gem.

But I have troubles figuring out what options does Humanizer expect and why, as all of those (freq, count, etc.) seem to be in RRule instance already. Could I ask to please add documentation on how to use Humanizer?

Thank you,
Yuri

Dominant language
Ruby
Stars
186
Forks
26
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from square/ruby-rrule

All issues in square/ruby-rrule

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.