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

1.2.0; the __mul* functions are showing in the toplevel docs #11327

Closed
wyhaines opened this issue Oct 16, 2021 · 0 comments · Fixed by #11326
Closed

1.2.0; the __mul* functions are showing in the toplevel docs #11327

wyhaines opened this issue Oct 16, 2021 · 0 comments · Fixed by #11326
Labels
kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:stdlib:runtime
Milestone
1.2.1

Comments

@wyhaines
Copy link
Contributor

I have a PR for this: #11326

The problem is simply that the :nodoc: marker is in the wrong spot to be applied when the macro generates code. That wee little PR moves it, and those functions are then properly nodoced and don't appear in the toplevel docs.
@wyhaines wyhaines added the kind:bug A bug in the code. Does not apply to documentation, specs, etc. label Oct 16, 2021
@oprypin oprypin mentioned this issue Oct 16, 2021
Merged
@straight-shoota straight-shoota added this to the 1.2.1 milestone Oct 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind:bug A bug in the code. Does not apply to documentation, specs, etc. topic:stdlib:runtime
Projects
None yet
Milestone
1.2.1
Development

Successfully merging a pull request may close this issue.

Move the nodoc flags to the right place to hide the __mul* functions. wyhaines/crystal
2 participants
@wyhaines @straight-shoota