From 994f9834eb99dd17317fba47b46915f6249098c5 Mon Sep 17 00:00:00 2001 From: Daniel Schmelz Date: Sun, 21 Aug 2022 15:35:10 +0200 Subject: [PATCH] Fix typos (#688) --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cb11e612..7b304a02 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ To get the most out of ParaTest, you have to adjust the parameters carefully. To allow full usage of your cpu cores, you should have at least one process per core. More processes allow better resource usage but keep in mind that each process has its own costs for spawning. The default is auto, which means - the number of logical CPU cores is set as number of processes. You might try something like logical `CPU cores * 2` + the number of logical CPU cores is set as the number of processes. You might try something like logical `CPU cores * 2` (e.g. if you have 8 logical cores, you might try `16`), but keep in mind that each process generates a little bit of overhead as well. @@ -67,20 +67,20 @@ To get the most out of ParaTest, you have to adjust the parameters carefully. 4. **Tune batch max size `--max-batch-size`** - Batch size will affect on max amount of atomic tests which will be used for single test method. + Batch size will affect the max amount of atomic tests which will be used for a single test method. One atomic test will be either one test method from test class if no data provider available for method or will be only one item from dataset for method. Increase this value to reduce per-process overhead and in most cases it will also reduce parallel efficiency. Decrease this value to increase per-process overhead and in most cases it will also increase parallel efficiency. - If amount of all tests less then max batch size then everything will be processed in one + If the amount of all tests is less than the max batch size then everything will be processed in one process thread so ParaTest is completely useless in that case. The best way to find the most effective batch size is to test with different batch size values and select best. - Max batch size = 0 means that grouping in batches will not be used and one batch will equal to + Max batch size = 0 means that grouping in batches will not be used and one batch will equal all method tests (one or all from data provider). - Max batch size = 1 means that each batch will contain only one test from data provider or one - method if data provider is not used. - Bigger max batch size can significantly increase phpunit command line length so process can fail. + Max batch size = 1 means that each batch will contain only one test from the data provider or one + method if the data provider is not used. + Bigger max batch size can significantly increase phpunit command line length so the process can fail. Decrease max batch size to reduce command line length. Windows has a limit around 32k, Linux - 2048k, Mac OS X - 256k. @@ -199,14 +199,14 @@ An example being: ParaTest assumes [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md) for loading tests. -For convenience, ParaTest for Windows uses 79 columns mode to prevent blank lines in standard +For convenience, ParaTest for Windows uses 79 columns mode to prevent blank lines in the standard 80x25 windows console. ## Caveats 1. Constants, static methods, static variables and everything exposed by test classes consumed by other test classes (including Reflection) are not supported. This is due to a limitation of the current implementation of `WrapperRunner` -and how PHPUnit searches for classes. The fix is put shared code into classes which are not tests _themselves_. +and how PHPUnit searches for classes. The fix is to put shared code into classes which are not tests _themselves_. ## Integration with PHPStorm