search

allenai / pdffigures2

Given a scholarly PDF, extract figures, tables, captions, and section titles.
http://pdffigures2.allenai.org/
Apache License 2.0
615 stars 123 forks source link

Improving readability of Readme #15

Closed wbt closed 7 years ago

wbt commented 7 years ago

Thanks for your work! This PR provides improvements to the documentation.
They might make the repo a little more attractive for others deciding what to build on/use.

chrisc36 commented 7 years ago

Looks good, my one gripe is that I generally prefer that bullet points do not end in periods.

wbt commented 7 years ago

A lot of them already did, so I went for consistency. As to which direction on consistency, I noted a moderately high average amount of complexity and complete sentences (usually more than one) in each list element. Having a period at the end signals the reader to pause and parse, which I think makes it easier to gain understanding, than requiring people to hold a lot more in memory at once before the thought is marked as closed (kind of like this sentence, provided for illustration).
Changing it is still clearly an option, but I thought I'd explain my logic first.

chrisc36 commented 7 years ago

All good points, I am sold. I will merge in your request.