Skip to content

Commit

Permalink
fix typos and add a bit more to README (#41)
Browse files Browse the repository at this point in the history
  • Loading branch information
rdnewman committed Jul 9, 2023
1 parent 33aa36f commit 8ed0182
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ The expectation is that Loba statements are just for development or test trace s

`Loba.ts` and `Loba.val` try to protect against timestamp or value notice requests being accidentally left in the code by checking for the Rails environment Loba is being invoked under. If in production, `Loba.ts` and `Loba.val` will normally just return immediately without attempting to render anything to help minimize any impact on production code.

However, that behavior can be overridden by using the options hash with `:production => true` as an additional last argument to output a notice even when in the production environment. In general, this should be avoided.
However, that behavior can be overridden by using the options hash with `:production => true` as an additional last argument to output a notice even when in the production environment. Note also behavior of the `log` option which defaults to `false` (introduced in v2.0.0). In general, enabling in production should be avoided. We're consenting adults.

WARNING: this gem depends on the [binding_of_caller gem](https://rubygems.org/gems/binding_of_caller) -- use `:production => true` with their warning in mind:
> **Recommended for use only in debugging situations. Do not use this in production apps.**
Expand Down
3 changes: 1 addition & 2 deletions readme/ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,11 @@ where
* `LL` ("in=...:") is the line number of the source code file that invoked `Loba.ts`, and
* `some_method` is the method in which `Loba.ts` was invoked.


##### Options

The following keyword argument may be specified when calling:
* `production`: true if this timestamp notice is to be enabled when running in :production environment (see ["Environment Notes"](README.md#environment-notes)) \[_default: `false`_\]
* `log`: `true` true if output is to be sent to both $STDOUT and to the Rails.logger (when availabe)
* `log`: `true` true if output is to be sent to both $STDOUT and to the Rails.logger (when available)

###### Examples using options
```ruby
Expand Down
2 changes: 1 addition & 1 deletion readme/val.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ The following options may be provided via keywords:
* `label`: give a string to explicitly provide a label to use in the notice (see sample above) \[_default: attempts to infer a label from the first argument]_\]
* `inspect`: true if this value notice is to use #inspect against the content being evaluated; occasionally, `inspect: false` can give a more useful result \[_default: `true`_\]
* `production`: true if this value notice is to be enabled when running in :production environment (see ["Environment Notes"](README.md#environment-notes)) \[_default: `false`_\]
* `log`: `true` true if output is to be sent to both $STDOUT and to the Rails.logger (when availabe)
* `log`: `true` true if output is to be sent to both $STDOUT and to the Rails.logger (when available)

###### Example 5: Using special options
```ruby
Expand Down

0 comments on commit 8ed0182

Please sign in to comment.