rdoc icon indicating copy to clipboard operation
rdoc copied to clipboard

Add a directive to track "since" version information

Open aprescott opened this issue 12 years ago • 5 comments

It can be useful when reading documentation to know in which version a method was first available. For example, when looking at Ruby's Enumerable#max_by latest documentation and wanting to know when it was first available.

A :since: <version> directive would support this.

aprescott avatar Sep 23 '13 19:09 aprescott

I approve this idea.

I think the directive should be only a version.

This would allow RDoc to have a page listing all the methods and their date of introduction.

Any details about changes to the method across versions should be listed in prose.

Also, Since: <version> should be acceptable since it looks more like plain text.

drbrain avatar Sep 23 '13 20:09 drbrain

fwiw, apidock does something like this already: http://apidock.com/ruby/Enumerable/max_by http://apidock.com/faq#What-is-the-bar-graph-on-the-top-of-documentation-pages

zzak avatar Sep 23 '13 20:09 zzak

Not enough time for this in RDoc 4.1, moving to the next release.

drbrain avatar Nov 14 '13 17:11 drbrain

You can see the rurema syntax here and here

zzak avatar Dec 02 '13 00:12 zzak

More info from the rurema wiki

zzak avatar Dec 02 '13 02:12 zzak