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.

Sign up for GitHub

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

Jump to bottom

:nodoc: on enum member does not also hide the generated question method #11333

Open
Blacksmoke16 opened this issue Oct 17, 2021 · 4 comments · May be fixed by #15375
Open

:nodoc: on enum member does not also hide the generated question method #11333

Blacksmoke16 opened this issue Oct 17, 2021 · 4 comments · May be fixed by #15375
Labels
status:discussion topic:tools:docs-generator

Comments

@Blacksmoke16
Copy link
Member

If you define an enum with a :nodoc: member, like:

enum Test
  FOO

  # :nodoc:
  BAR
end

The member itself will be hidden, but the autogenerated bar? method ill not:

image

I think it would make sense to also hide the method.
@Blacksmoke16 Blacksmoke16 added the kind:bug A bug in the code. Does not apply to documentation, specs, etc. label Oct 17, 2021
@asterite
Copy link
Member

Pretty hard, the regular compiler doesn't know about doc comments.

@straight-shoota
Copy link
Member

What would be a use case for a nodoc enum member anyways?

@straight-shoota straight-shoota added status:discussion topic:tools:docs-generator and removed kind:bug A bug in the code. Does not apply to documentation, specs, etc. labels Oct 18, 2021
@asterite
Copy link
Member

What I said doesn't make sense, sorry.

Regex options are one place where there are nodoc values.

@Blacksmoke16
Copy link
Member Author

Yea Regex::Options is where i noticed it. Granted, probably a bit of an edge case.

nobodywasishere added a commit to nobodywasishere/crystal that referenced this issue Jan 26, 2025
@nobodywasishere
Copy docs from enum members to their helper methods (crystal-lang#11333)
1e3aac8
@nobodywasishere nobodywasishere linked a pull request Jan 26, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status:discussion topic:tools:docs-generator
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Copy docs from enum members to their helper methods (#11333) nobodywasishere/crystal
3 participants
@asterite @straight-shoota @Blacksmoke16