Skip to content

Add support for deprecated parameters in doc generator#16012

Merged
straight-shoota merged 3 commits intocrystal-lang:masterfrom
straight-shoota:feat/doc-generator-deprecated-parameters
Jul 23, 2025
Merged

Add support for deprecated parameters in doc generator#16012
straight-shoota merged 3 commits intocrystal-lang:masterfrom
straight-shoota:feat/doc-generator-deprecated-parameters

Conversation

@straight-shoota
Copy link
Member

A deprecation annotation on a parameter generates a deprecation notice on the API doc for the method.

# This is foo
def foo(@[Deprecated("Do not use")] x = 1)
end

This is foo.

DEPRECATED parameter x
Do not use.

This goes alongside #15999 which adds deprecation warnings for deprecated parameters.

@straight-shoota straight-shoota added this to the 1.18.0 milestone Jul 21, 2025
@straight-shoota straight-shoota merged commit 1e5b31e into crystal-lang:master Jul 23, 2025
38 checks passed
@straight-shoota straight-shoota deleted the feat/doc-generator-deprecated-parameters branch July 23, 2025 11:06
@straight-shoota straight-shoota changed the title Add suppport for deprecated parameters in doc generator Add support for deprecated parameters in doc generator Sep 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants