[flac-dev] [Cellar] FLAC Markdown

[Dave Rice]

Hi all,

> On Jun 5, 2017, at 11:52 PM, Andrew James Weaver <weevz at uw.edu> wrote:
> 
> Hello all!
> (cc-ing the flac-dev list)
> 
> I would like to give an update as to the recent CELLAR work on the FLAC specification.
> 
> • Work has been done to make internal and external links more accurate and reliable.
> • 'Rice Coding' has been clarified as 'Exponential Golomb Coding.'
> • Clarifications have been made for binary representation.
> • Typos and other small changes have been fixed for clarity.
> 
> Lastly, a version 00 release has been made (available at https://github.com/privatezero/flac_markdown/releases <https://github.com/privatezero/flac_markdown/releases>) and the draft document has been uploaded to the IETF datatracker (https://datatracker.ietf.org/doc/draft-xiph-cellar-flac/ <https://datatracker.ietf.org/doc/draft-xiph-cellar-flac/>)
> 
> All the best!
> Andrew Weaver

From a review of the markdown and the rendered RFC, I’d like to consider renaming many of the components of FLAC from the ALL_CAPS_WITH_UNDERSCORE_STYLE to `Title Case Names in BackTicks` (which is similar to how local components have been named and referenced in the FFV1 and Matroska documents). Thus “METADATA_BLOCK_HEADER” would be `Metadata Block Header` and expressed with that same case and quoting at each reference. I also suggest that the metadata block types such as “METADATA_BLOCK_STREAMINFO” and “METADATA_BLOCK_APPLICATION” simply be renamed as `Streaminfo Block` and `Application Block` and that each of those components be defined as being a `Metadata Block`.

I may send a pull request for this soon but wanted to ask around in case there’s some reason for or advantage of the ALL_CAPS_WITH_UNDERSCORE_STYLE that I’m missing.

Best Regards,
Dave Rice

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.xiph.org/pipermail/flac-dev/attachments/20170606/343a1482/attachment.html>