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

Cannot :nodoc: def_clone macro #15356

Open
Blacksmoke16 opened this issue Jan 19, 2025 · 0 comments
Open

Cannot :nodoc: def_clone macro #15356

Blacksmoke16 opened this issue Jan 19, 2025 · 0 comments
Labels
good first issue This is an issue suited for newcomers to become aquianted with working on the codebase. kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:tools:docs-generator

Comments

@Blacksmoke16
Copy link
Member

Bug Report

Somewhat related to #14039, the def_clone macro has a comment directly on the method generated by the macro. This makes it so you cannot customize the API docs for the generated method. My use case being wanting to throw a :nodoc: on it.

Easiest solution would be to remove the default comment, but could maybe do something with https://crystal-lang.org/reference/1.15/syntax_and_semantics/macros/index.html#merging-expansion-and-call-comments to only use it if there is not a doc comment on the macro call.

@Blacksmoke16 Blacksmoke16 added kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:tools:docs-generator good first issue This is an issue suited for newcomers to become aquianted with working on the codebase. labels Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue This is an issue suited for newcomers to become aquianted with working on the codebase. kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:tools:docs-generator
Projects
None yet
Development

No branches or pull requests

1 participant