add UnitGroup docs; import UnitGroup in REPL #239
Conversation
| @@ -1200,6 +1306,7 @@ trait LoadRoute extends HttpService { | |||
| * Shadaj Laddad ([shadaj](https://github.com/shadaj)) | |||
| * Ian McIntosh ([cranst0n](https://github.com/cranst0n)) | |||
| * Doug Hurst ([robotsnowfall](https://github.com/robotsnowfall)) | |||
| * Philip Axelrod ([Paxelord](https://github.com/paxelord)) | |||
There was a problem hiding this comment.
Haha. Yes. I just added a comment to #238 about this. No problem.
| @@ -637,6 +637,79 @@ implicit val moneyNum = new MoneyNumeric() | |||
| val sum = List(USD(100), USD(10)).sum | |||
| ``` | |||
|
|
|||
| ## Unit groups | |||
There was a problem hiding this comment.
Just a refresher, this generates the top README.md right?
There was a problem hiding this comment.
Yes, this will build the main README.
|
|
||
| // squants automatically sorts units | ||
| usCookingUnitGroup.sortedUnits.foreach(println) | ||
| // squants.space.Teaspoons$@797a286f |
There was a problem hiding this comment.
Because this output includes memory locations, this part of the README will change every time tut is run.
As a future enhancement we should provide a stable toString for UnitOfMeasure that outputs the unit's name.
There was a problem hiding this comment.
Or reduce the top README to a placeholder and put the documentation on github site, The README is getting fairly large
There was a problem hiding this comment.
Yes, I've been thinking we should split the README up into multiple smaller files. Probably just have the sbt instructions and a small quick example in the main README. I can tackle that in a later PR after this round gets merged.
There was a problem hiding this comment.
It would be great to export this documentation to squants.com, That still shows version 0.6.2 😄
There was a problem hiding this comment.
Agreed. I think updating squants.com should be the next priority after this release.
|
Are we ok to merge this? |
This adds docs for the new
UnitGroupfunctionality. Feedback on docs would be appreciated.