Skip to content

Please add support for deprecated tag #339

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

Closed
b4ldr opened this issue Feb 17, 2023 · 0 comments · Fixed by #342
Closed

Please add support for deprecated tag #339

b4ldr opened this issue Feb 17, 2023 · 0 comments · Fixed by #342

Comments

@b4ldr
Copy link
Contributor

b4ldr commented Feb 17, 2023

Use Case

I recently tried to use the deprecated yard tag hoping that this would create some type of deprecated label on the resulting documentation however as far as i can tell it had no affect. Could we please add support for the deprecated tag.

Describe the Solution You Would Like

When using the @deprecated tag mark functions in the resulting documentation with a deprecated header e.g.

# some function
Puppet::Functions.create_function(:deprecated_function) do
  # @deprecated this function causes issues
 ...
end

should result in something like

### <a name="deprecated_function"></a>`deprecated_function`

Type: Ruby 4.x API

[DEPRECATD]  this function causes issues

some function
...
@b4ldr b4ldr added the feature label Feb 17, 2023
b4ldr added a commit to b4ldr/puppet-strings that referenced this issue Mar 10, 2023
I had a stab at adding the deprecated flag

Fixes puppetlabs#339
b4ldr added a commit to b4ldr/puppet-strings that referenced this issue Mar 14, 2023
I had a stab at adding the deprecated flag

Fixes puppetlabs#339
b4ldr added a commit to b4ldr/puppet-strings that referenced this issue Mar 15, 2023
I had a stab at adding the deprecated flag

Fixes puppetlabs#339
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants