Skip to content

Commit 41ae7ad

Browse files
committed
Fix English in README (#7)
- 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
1 parent ed82758 commit 41ae7ad

1 file changed

Lines changed: 19 additions & 24 deletions

File tree

README.md

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
Goal
44
----
55

6-
This librairy helps you to write Excel files (`xlsx`) as fast as possible without, hopefully, blowing your heap.
6+
This library helps you write Excel files (`xlsx`) as fast as possible without, hopefully, blowing your heap.
77

88
It's meant to be used in JRuby programs.
9-
It can be used in Scala programs, of course, but there're better, pure, ways with such language to achieve the same goal.
9+
It can be used in Scala programs, of course, but there are better, pure, ways with such language to achieve the same goal.
1010

11-
It's a very opinionated librairy which does not provides you all the possible customizations.
12-
For example, it'll use all your CPU cores to compute the rows, it's not configurable and will maybe never be.
11+
It's a very opinionated library that does not provide all the possible customizations.
12+
For example, it'll use all your CPU cores to compute the rows. It's not configurable and may never be.
1313

1414
Be sure to read and understand the [heap usage considerations](#heap-usage-considerations) and [CPU usage considerations](#cpu-usage-considerations)
1515
chapters of this README before using this lib in a production environment.
@@ -37,7 +37,7 @@ java_import 'com.colisweb.jruby.concurrent.constant.memory.excel.Cell'
3737
header = ["A", "B", "C"].to_java(:string)
3838
sheet_name = "cars"
3939

40-
# Curently, support only one sheet per workbook.
40+
# Currently, only one sheet per workbook is supported.
4141
#
4242
workbook_state = ConcurrentConstantMemoryExcel.newWorkbookState(sheet_name, header)
4343

@@ -74,64 +74,59 @@ queries.each_with_index { |query, index|
7474

7575
compute_rows_lambda = to_parametrize_compute_rows_lambda.call(query)
7676

77-
# Do not launch any computation. It just registers required computations in the `workbook_state`.
77+
# Does not launch any computation. It just registers required computations in the `workbook_state`.
7878
#
7979
# The second argument for this function call should be a lambda taking no parameter.
8080
#
8181
ConcurrentConstantMemoryExcel.addRows(workbook_state, compute_rows_lambda, index.to_java(:int))
8282

8383
}
8484

85-
# Computations of rows will really begin with this function call. Not before.
85+
# Computation of rows will really begin with this function call. Not before.
8686
#
8787
ConcurrentConstantMemoryExcel.writeFile(workbook_state, "path/to/my/file") # will write a file named `file.xlsx` in the `path/to/my` directory.
8888
```
8989

9090
Heap usage considerations
9191
-------------------------
9292

93-
This librairy parallelizes the computations of your rows using `n` threads, where `n` is the number of cores your CPU has.
93+
This library parallelizes the computation of your rows using `n` threads, where `n` is the number of cores your CPU has.
9494

9595
For each call to the `addRows` function, a computation is registered in the `workbook_state`.
9696

9797
When the `writeFile` function is called, all the registered computations will be launched, `n` by `n`.
9898

99-
So the maximum quantity of RAM this lib can use is equal to `n` times the quantity of RAM required to compute the `compute_rows_lambda`.
99+
So the maximum amount of RAM this lib can use is equal to `n` times the amount of RAM required to compute the `compute_rows_lambda`.
100100

101-
If your program OOM, the only way to fix that is by reducing the size of the result the `query` passed to the `parametrized_compute_rows_lambda` gives you when executed.
101+
If your program OOMs, the only way to fix that is by reducing the size of the result the `query` passed to the `parametrized_compute_rows_lambda` gives you when executed.
102102

103103
CPU usage considerations
104104
-------------------------
105105

106-
Because this lib knows nothing about the computations you'll ask it to execute, in order to maximise the CPU usage,
107-
and so the speed of your Excel extraction, you'll have to ensure that the number of registered computations (number of call to the `addRows` function)
108-
is superior or equal to the number of cores your CPU has.
106+
Because this lib knows nothing about the computations you'll ask it to execute, in order to maximise CPU usage
107+
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)
108+
is greater than or equal to the number of cores your CPU has.
109109

110-
If it's inferior to that number, maybe you can write your `queries` in a different way.
110+
If it's fewer than that number, you may be able to write your `queries` in a different way.
111111

112-
For example, instead of making 4 `query` each computing `1000` rows, you can write 8 `query` computing `500` rows.
113-
On a 8 cores machines, the result can be computed up to 2 times faster in this case.
112+
For example, instead of making 4 queries each computing `1000` rows, you can write 8 queries computing `500` rows.
113+
On an 8-core machine, the result can be computed up to 2 times faster in this case.
114114

115115
Coding Style
116116
------------
117117

118-
This project is a Scala librairy meant to be used in JRuby projects.
118+
This project is a Scala library meant to be used in JRuby projects.
119119

120120
*That explains the quite impure style used in the Scala code.*
121121

122122
Acknowledgments
123123
---------------
124124

125-
We want to thanks:
125+
We want to thank:
126126

127127
- Nicolas Rinaudo [@NicolasRinaudo](https://twitter.com/NicolasRinaudo)
128128
- Elijah Rippeth [@terrible_coder](https://twitter.com/terrible_coder)
129129
- Mathieu Besançon [@matbesancon](https://twitter.com/matbesancon)
130130
- Charles Oliver Nutter [@headius](https://twitter.com/headius)
131131

132-
for their help in the writting of this lib.
133-
134-
🙂
135-
136-
137-
132+
for their help in writing this lib.

0 commit comments

Comments
 (0)