README.md in osut-0.2.0 vs README.md in osut-0.2.1
- old
+ new
@@ -11,10 +11,11 @@
... in a v2.1 [bundled](https://bundler.io) _Measure_ development environment "Gemfile" (or instead as a _gemspec_ dependency), and then run:
```
bundle install (or 'bundle update')
```
+
### Recommended use
As a Ruby module, one can access __osut__ by extending a _Measure_ module or class:
```
@@ -23,10 +24,10 @@
module M
extend OSut
...
end
```
-The logger module [oslg](https://github.com/rd2/oslg) is an __osut__ dependency. _Measure_ developers can (optionally) choose to log debug, informative, warning or error messages from within an __osut__-extended module or class, e.g.:
+The logger module [oslg](https://github.com/rd2/oslg) is an __osut__ dependency: DEBUG, WARN and/or ERROR messages may be logged by __osut__, usually as a result of invalid method calls or bad OpenStudio input. _Measure_ developers can (optionally) choose to continue logging messages from within an __osut__-extended module or class, e.g.:
```
M.log(OSut::WARN, "Calculated material thickness > 1m")
```
... and then decide (at any given stage in the _Measure_) what to log to the OpenStudio runner, vs an automatically-generated results report (e.g. for code compliance), vs a bug report.