search

dpalmasan / TRUNAJOD2.0

An easy-to-use library to extract indices from texts.
https://trunajod20.readthedocs.io/en/latest/
MIT License
29 stars 7 forks source link

Minor stylistic suggestions #56

Closed apiad closed 3 years ago

apiad commented 3 years ago

I took the liberty of directly editing the text where I feel it could be improved. Please feel free to accept/modify/reject whichever change you consider suitable.

My main purpose with these small modifications was to improve clarity just a bit by shortening long sentences and rephrasing a few parts that I considered somewhat strange, but again, it's mostly a stylistic matter and the authors have the last word on this.

I added a <NAME?> on line 40 (mid-paragraph) to indicate that, in my view, it looks better if the citation has a proper name, e.g., "one open-source project is Something [1]" instead of just "... is [1]". My rule of thumb is that removing all citations from the text should not make it unreadable or grammatically incorrect. Feel free to decide if this is something you want to fix.

Referencing openjournals/joss-reviews#3153 for backlinking.

Hope it helps! :smile:

dpalmasan commented 3 years ago

Hello @apiad thank you for the stylistic changes! It looks great! I added a commit just to fill the name in the <NAME?> marker for the framework name I am describing in that paragraph. I am merging these changes!

apiad commented 3 years ago

Yeah, that was just perfect. Glad to be able to collaborate just a bit :smile:! Kudos again!