squash! comments

Author: devsnek

doc/bigint.md

@@ -11,8 +11,8 @@ static BigInt New(Napi::Env env, int64_t value);
 static BigInt New(Napi::Env env, uint64_t value);
 ```
 
- - `[in] env`: The `napi_env` Environment
- - `[in] value`: The value the JavaScript BigInt will contain
+ - `[in] env`: The environment in which to construct the `BigInt` object.
+ - `[in] value`: The value the JavaScript `BigInt` will contain
 
 These APIs convert the C `int64_t` and `uint64_t` types to the JavaScript
 `BigInt` type.
@@ -24,8 +24,8 @@ static BigInt New(Napi::Env env,
                   const uint64_t* words);
 ```
 
- - `[in] env`: The `napi_env` Environment
- - `[in] sign_bit`: Determines if the resulting BigInt will be positive or negative.
+ - `[in] env`: The environment in which to construct the `BigInt` object.
+ - `[in] sign_bit`: Determines if the resulting `BigInt` will be positive or negative.
  - `[in] word_count`: The length of the words array.
  - `[in] words`: An array of `uint64_t` little-endian 64-bit words.
 
@@ -41,7 +41,7 @@ The resulting `BigInt` is calculated as: (–1)<sup>`sign_bit`</sup> (`words[0]`
 Napi::BigInt();
 ```
 
-Returns a new empty JavaScript BigInt.
+Returns a new empty JavaScript `BigInt`.
 
 
 ### Int64Value
@@ -50,44 +50,44 @@ Returns a new empty JavaScript BigInt.
 int64_t Int64Value(bool* lossless) const;
 ```
 
- - `[out] lossless`: Indicates whether the BigInt value was converted
+ - `[out] lossless`: Indicates whether the `BigInt` value was converted
    losslessly.
 
 This API returns the C `int64_t` primitive equivalent of the given JavaScript
-BigInt. If needed it will truncate the value, setting lossless to false.
+`BigInt`. If needed it will truncate the value, setting lossless to false.
 
 ### Uint64Value
 
 ```cpp
 uint64_t Uint64Value(bool* lossless) const;
 ```
 
- - `[out] lossless`: Indicates whether the BigInt value was converted
+ - `[out] lossless`: Indicates whether the `BigInt` value was converted
    losslessly.
 
 This API returns the C `uint64_t` primitive equivalent of the given JavaScript
-BigInt. If needed it will truncate the value, setting lossless to false.
+`BigInt`. If needed it will truncate the value, setting lossless to false.
 
 ### WordCount
 
 ```cpp
 size_t WordCount() const;
 ```
 
-Returns the number of words needed to store this BigInt value.
+Returns the number of words needed to store this `BigInt` value.
 
 ### ToWords
 
 ```cpp
 void ToWords(size_t* word_count, int* sign_bit, uint64_t* words);
 ```
 
- - `[out] sign_bit`: Integer representing if the JavaScript BigInt is positive
+ - `[out] sign_bit`: Integer representing if the JavaScript `BigInt` is positive
    or negative.
  - `[in/out] word_count`: Must be initialized to the length of the words array.
    Upon return, it will be set to the actual number of words that would be
-   needed to store this BigInt.
+   needed to store this `BigInt`.
  - `[out] words`: Pointer to a pre-allocated 64-bit word array.
 
-This API converts a single BigInt value into a sign bit, 64-bit little-endian
+This API converts a single `BigInt` value into a sign bit, 64-bit little-endian
 array, and the number of elements in the array.

test/bigint.cc

@@ -48,7 +48,7 @@ Value TestWords(const CallbackInfo& info) {
 
   if (word_count != expected_word_count) {
     Error::New(info.Env(), "word count did not match").ThrowAsJavaScriptException();
-    return;
+    return BigInt();
   }
 
   return BigInt::New(info.Env(), sign_bit, word_count, words);