Polish the English in the documentation

RazrFalcon / xmlparser

A low-level, pull-based, zero-allocation XML 1.0 parser.

Apache License 2.0

130 stars 16 forks source link

Closed kneasle closed 4 years ago

kneasle commented 4 years ago

Hi!

Awesome library - I've been using it in a project and it does exactly what I want without any fuss - thanks for making it! :+1: from me.

I've polished the English a bit in the documentation - I haven't changed the meaning, just made it read better.

Is README.md generated automatically from the root doc comment or should I update it manually?

Cheers!

-- Kneasle

RazrFalcon commented 4 years ago

Thanks.

Is README.md generated automatically from the root doc comment or should I update it manually?

Yes. I'm using cargo readme > README.md (cargo-readme). But you can do the same manually, I guess.

kneasle commented 4 years ago

Cool - README.md has been updated!

RazrFalcon commented 4 years ago

Thanks!