[nfc] Reorganize and Rename Appendices

chipsalliance / firrtl-spec

The specification for the FIRRTL language

44 stars 28 forks source link

[nfc] Reorganize and Rename Appendices #141

Closed mmaloney-sf closed 11 months ago

mmaloney-sf commented 11 months ago

Move "Primitive Operations" section closer to the bottom.
Rename a "FIRRTL Language Definition" to "Grammar".
Rename "Details about Syntax" to "Notes on Syntax".

seldridge commented 11 months ago

Only thing that would be good for this type of thing is to add entries to the revision-history.yaml and to use commit/PR tags. E.g., [nfc].

mmaloney-sf commented 11 months ago

@seldridge Done.

I'm a little worried about spamming the revision section with all the changes I want to make during this reorganization effort. Any thoughts on how to mitigate that?

seldridge commented 11 months ago

It's fine if there wind up being a lot of entries. Alternatively, the revision-history can just be amended. Obviously, don't edit anything in oldVersions. However, thisVersion can be updated as opposed to always adding new items.

mmaloney-sf commented 11 months ago

I'm also moving the "Literals" section. It feels like it got separated from the herd. It's not important enough for its own top-level section, and I'm sticking it under the "Notes on Syntax" section.

I'm also removing the heading on radix-specified integer literals. (The content is still there).