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.

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

Add :deprecated: and :since: directives #994

Open
halostatue opened this issue Apr 24, 2023 · 1 comment
Open

Add :deprecated: and :since: directives #994

halostatue opened this issue Apr 24, 2023 · 1 comment

Comments

@halostatue
Copy link

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.6
def foo(flag)
  # ...
end

# This function...
#
# :since: 3.0
def bar(enable: false)
  # ...
end
@hsbt
Copy link
Member

hsbt commented Apr 24, 2023

@halostatue Thanks to file this idea. I'm +1 to this feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants