palkan / logidze

Database changes log for Rails
MIT License
1.59k stars 74 forks source link

Replace #versions with #logidze_versions in README #245

Closed miharekar closed 6 months ago

miharekar commented 6 months ago

Saw this today, and wanted to use it, and learned that README is all wrong 😅

It was implemented as #logidze_versions in #238.

And here are the results:

irb(main):043> cafe.logidze_versions.map{|v| v.log_version}
=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
irb(main):044> cafe.logidze_versions(reverse: true).map{|v| v.log_version}
=> [12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1]
irb(main):045> cafe.logidze_versions(include_self: true).map{|v| v.log_version}
=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
irb(main):046> cafe.logidze_versions(reverse: true, include_self: true).map{|v| v.log_version}
=> [13, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1]

So most of the readme of this method is currently wrong 🙈

What is the purpose of this pull request?

Fix README and CHANGELOG to be correct.

What changes did you make? (overview)

Is there anything you'd like reviewers to focus on?

Checklist

palkan commented 6 months ago

Oops :( Thanks for fixing this!