zig icon indicating copy to clipboard operation
zig copied to clipboard

Docgen improve code readability

Open perillo opened this issue 2 years ago • 2 comments

Attempt to improve the readability and consistency of docgen.

perillo avatar Dec 22 '23 20:12 perillo

do u have a before/after screenshot?

nektro avatar Dec 22 '23 20:12 nektro

do u have a before/after screenshot?

You can just read each commit diff.

Just in case there is misunderstanding, this PR does not improve the readability of the Zig Language Reference, but the readability of the docgen tool.

perillo avatar Dec 23 '23 11:12 perillo

No thanks. The only actual thing this does is slightly increase the number of bytes users download from the langref.

andrewrk avatar Jan 09 '24 07:01 andrewrk

@andrewrk, I added multiple commits so that do you can discard the ones you don't like.

If the problem is the increase size of langref, you can just remove 2e2c4cf (and probably also you can also a340d27).

However I think additional 8 bytes are a good price for consistency.

Thanks.

perillo avatar Jan 09 '24 09:01 perillo