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

compiler: remove doc comments from Zir #22245

Merged
merged 1 commit into from
Dec 16, 2024
Merged

Conversation

mlugg
Copy link
Member

@mlugg mlugg commented Dec 15, 2024

This code was left over from the legacy Autodoc implementation. No component of the compiler pipeline actually requires doc comments, so it is a waste of time and space to store them in ZIR.

This code was left over from the legacy Autodoc implementation. No
component of the compiler pipeline actually requires doc comments, so it
is a waste of time and space to store them in ZIR.
@andrewrk
Copy link
Member

andrewrk commented Dec 15, 2024

I considered this when looking into #131 but I concluded that doc comments would be desirable for #615.

You can make the call. It's possible for the compiler server we decide to get that information based on the AST instead. YAGNI principles would say go ahead and merge this.

@mlugg
Copy link
Member Author

mlugg commented Dec 16, 2024

Yeah, I suspect #615 won't really benefit from this. I think I'll go ahead and merge it for now -- it'll be relatively easy to reintroduce if we ever do need the doc comments in ZIR.

@mlugg mlugg enabled auto-merge December 16, 2024 00:05
@mlugg mlugg merged commit 3a0a9aa into ziglang:master Dec 16, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants