Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add YARD documentation #40

Merged
merged 3 commits into from
Jul 20, 2020
Merged

Add YARD documentation #40

merged 3 commits into from
Jul 20, 2020

Conversation

dzunk
Copy link
Owner

@dzunk dzunk commented Jul 19, 2020 •
edited
Loading

Closes #4

Adds YARD documentation to (most of) the gem, which will be available at https://rubydoc.info/gems/redis-time-series once the next release goes out.

I skipped a few places:

  • madd commands, because I'm still not 100% sure about that interface
  • Filters class, because it needs refactoring as per Codeclimate

Minor interface changes that probably aren't even worth mentioning:

  • Renamed Sample#ts_msec to Sample#to_msec
  • Added Time.from_msec to the TimeMsec refinement

@dzunk dzunk marked this pull request as ready for review July 20, 2020 00:14
@dzunk dzunk merged commit 4156185 into master Jul 20, 2020
@dzunk dzunk deleted the docs branch July 20, 2020 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add YARD docs to public time series methods
1 participant
@dzunk