Better documentation of default_batch_size (simdjson#1056)

lemire · web-flow · commit fc8a46025e0b · 2020-07-21T15:15:21.000-04:00
* Better documentation of default_batch_size

* Retweaking.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -71,6 +71,12 @@ Pull requests are always invited. However, we ask that you follow these guidelin
 
 If the benefits of your proposed code remain unclear, we may choose to discard your code: that is not an insult, we frequently discard our own code. We may also consider various alternatives and choose another path. Again, that is not an insult or a sign that you have wasted your time.
 
+Style
+-----
+
+Our formatting style is inspired by the LLVM style.
+The simdjson library is written using the snake case: when a variable or a function is a phrase,  each space is replaced by an underscore character, and the first letter of each word written in lowercase.  Compile-time constants are written entirely in uppercase with the same underscore convention.
+
 Code of Conduct
 ---------------
 
diff --git a/include/simdjson/dom/parser.h b/include/simdjson/dom/parser.h
@@ -196,7 +196,7 @@ class parser {
    * @param batch_size The batch size to use. MUST be larger than the largest document. The sweet
    *                   spot is cache-related: small enough to fit in cache, yet big enough to
    *                   parse as many documents as possible in one tight loop.
-   *                   Defaults to 10MB, which has been a reasonable sweet spot in our tests.
+   *                   Defaults to 1MB (as simdjson::dom::DEFAULT_BATCH_SIZE), which has been a reasonable sweet spot in our tests.
    * @return The stream, or an error. An empty input will yield 0 documents rather than an EMPTY error. Errors:
    *         - IO_ERROR if there was an error opening or reading the file.
    *         - MEMALLOC if the parser does not have enough capacity and memory allocation fails.
