mookid / diffr

Yet another diff highlighting tool
MIT License
575 stars 22 forks source link

Documentation: wrong syntax description #40

Closed grossjohann closed 4 years ago

grossjohann commented 4 years ago

diffr --help prints this:

            color_spec = face-name + ':' + attributes
            attributes = <empty>
                       | attribute + ':' + attributes

This means that a color_spec always ends with a colon, but I'm sure this wasn't intended. Maybe reword like this:

            color_spec = face-name + ':' + attributes
            attributes = attribute
                       | attribute + ':' + attributes

This is more restrictive than the original grammar because it requires at least one attribute. I don't know if that matches the implementation. But it would be easy to fix by allowing color_spec to expand to either a bare face-name or to face-name + ':' + attributes.

mookid commented 4 years ago

Great catch! The doc change you suggest is definitely what I had in mind. Would you submit a PR for that?

mookid commented 4 years ago

thanks!

grossjohann commented 4 years ago

Thank you very much!