You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
On ruby-core, a suggestion was made to add version information to all function documentation. I think that making it easier to do in a standardized way would be good. In my comment, I suggested a couple of directives:
:deprecated since:
:since:
I believe that :deprecated: is a better choice than :deprecated since:.
This isn’t entirely necessary, but it would make adopting this to be generated in a standard place for both web generated code and RI.
This would be used as:
# This function...# Use #bar instead.## :deprecated: 2.6deffoo(flag)# ...end# This function...## :since: 3.0defbar(enable: false)# ...end
The text was updated successfully, but these errors were encountered:
On ruby-core, a suggestion was made to add version information to all function documentation. I think that making it easier to do in a standardized way would be good. In my comment, I suggested a couple of directives:
:deprecated since:
:since:
I believe that
:deprecated:
is a better choice than:deprecated since:
.This isn’t entirely necessary, but it would make adopting this to be generated in a standard place for both web generated code and RI.
This would be used as:
The text was updated successfully, but these errors were encountered: