Conversation
- librairy → library - there're → there are - does not provides → does not provide - will maybe never be → may never be - Curently → Currently - Do not launch → Does not launch - Computations → Computation - quantity → amount - OOM → OOMs - superior or equal → greater than or equal - inferior → fewer - thanks → thank - writting → writing
There was a problem hiding this comment.
Pull request overview
This PR improves the English in the project README to make the library description and usage guidance clearer for readers.
Changes:
- Corrects typos (e.g., “librairy” → “library”, “writting” → “writing”) and grammar throughout the README.
- Refines phrasing in several sections (goal/intro, heap and CPU usage considerations, acknowledgments) for clarity.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| It's meant to be used in JRuby programs. | ||
| It can be used in Scala programs, of course, but there're better, pure, ways with such language to achieve the same goal. | ||
| It can be used in Scala programs, of course, but there are better, pure, ways with such language to achieve the same goal. |
There was a problem hiding this comment.
This sentence still reads ungrammatically/awkwardly ("better, pure, ways" and "such language"). Consider rephrasing (e.g., remove the commas and use "such a language" / "in Scala"), so the meaning is clear.
Suggested change
| It can be used in Scala programs, of course, but there are better, pure, ways with such language to achieve the same goal. | |
| It can be used in Scala programs, of course, but there are better, purer ways in Scala to achieve the same goal. |
Comment on lines
+106
to
+108
| Because this lib knows nothing about the computations you'll ask it to execute, in order to maximise CPU usage | ||
| and therefore the speed of your Excel extraction, you'll have to ensure that the number of registered computations (number of calls to the `addRows` function) | ||
| is greater than or equal to the number of cores your CPU has. |
There was a problem hiding this comment.
The sentence break here makes the clause structure a bit incorrect/unclear ("Because …, in order to … and therefore …"). Consider rewriting as a single sentence (e.g., "Because …, to maximise CPU usage (and therefore speed), …") for readability.
Suggested change
| Because this lib knows nothing about the computations you'll ask it to execute, in order to maximise CPU usage | |
| and therefore the speed of your Excel extraction, you'll have to ensure that the number of registered computations (number of calls to the `addRows` function) | |
| is greater than or equal to the number of cores your CPU has. | |
| Because this lib knows nothing about the computations you'll ask it to execute, to maximise CPU usage and therefore the speed of your Excel extraction, you'll have to ensure that the number of registered computations (number of calls to the `addRows` function) is greater than or equal to the number of cores your CPU has. |
guizmaii
added a commit
that referenced
this pull request
Apr 13, 2026
- librairy → library - there're → there are - does not provides → does not provide - will maybe never be → may never be - Curently → Currently - Do not launch → Does not launch - Computations → Computation - quantity → amount - OOM → OOMs - superior or equal → greater than or equal - inferior → fewer - thanks → thank - writting → writing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary