Update Ricardian spec to version 0.2 #22
Conversation
README.md
Outdated
|
|
||
| * `amount_from_asset` - Given a variable containing an asset, extract and return the amount. | ||
|
|
||
| * `symbol_name_from_asset` - Given a variable containing an asset, extract and return the symbol name. |
There was a problem hiding this comment.
Since this is redundant with asset_to_symbol_code can we mark this as deprecated?
There was a problem hiding this comment.
Either one. Personally I prefer this one - the name seems more descriptive, and it's nicely symmetric with the amount_from_asset helper.
README.md
Outdated
| In addition to the standard helpers which are part of Handlebars, there are a number of additional helpers defined to assist with Ricardian contract specific issues. | ||
|
|
||
| ___Since 0.0___ | ||
| * `wrap` - Takes no parameters. Block level helper to wrap the contents with `<div>` tags for highlighting. See `Variables` section above for more details. |
There was a problem hiding this comment.
for the Variables mentions here and below - might be helpful to link the header in the README, like so Variables
README.md
Outdated
|
|
||
| {{ asset_to_symbol_code asset }} --> 'EOS'. | ||
|
|
||
| ___Since 0.1___ |
There was a problem hiding this comment.
Are these references to versions? If so, maybe __Since v0.1___ would be more clear here
| asset = '2.001 EOS' | ||
|
|
||
| {{ amount_from_asset asset }} --> '2.001'. | ||
|
|
There was a problem hiding this comment.
Looks like you might be missing a closing ``` here for the example above
There was a problem hiding this comment.
TIL that VSCode markdown preview masks when closing ``` are missing.
README.md
Outdated
|
|
||
| {{ amount_from_asset asset }} --> '2.001'. | ||
|
|
||
| * `symbol_name_from_asset` - Given a variable containing an asset, extract and return the symbol name. For example: '2.001 EOS' --> returns 'EOS'. |
There was a problem hiding this comment.
You can also remove the example in this description (For example: '2.001 EOS' --> returns 'EOS'.) since you added it below
README.md
Outdated
| asset = '2.001 EOS' | ||
|
|
||
| {{ symbol_name_from_asset asset }} --> 'EOS'. | ||
|
|
There was a problem hiding this comment.
It looks like the closing ``` is missing here as well
Mainly adds a section defining the available helpers and which version of the spec they became available in.
README.md
Outdated
| @@ -97,6 +97,115 @@ In cases where this default variable wrapping can cause problems (e.g. a variabl | |||
|
|
|||
| `{{#wrap}}[{{nowrap link.text}}]({{nowrap link.url}}){{/wrap}}` | |||
|
|
|||
| #### Handlebars helpers | |||
There was a problem hiding this comment.
We're using Title Case throughout; let's uppercase "helpers".
README.md
Outdated
| {{ else }} | ||
| Render if myVar is undefined or null | ||
| {{/if_has_value}} | ||
| ``` | ||
| #### HTML in variables |
There was a problem hiding this comment.
Let's go ahead and uppercase "variables" too.
README.md
Outdated
| auth = { | ||
| "actor": "alicejones", | ||
| "permission": "active" | ||
| } |
There was a problem hiding this comment.
Indentation could be improved here.
README.md
Outdated
|
|
||
| In Ricardian contract: | ||
| {{ permission_in_permission_level auth }} --> 'active' | ||
| ``` |
There was a problem hiding this comment.
Indentation could be improved here.
There was a problem hiding this comment.
Because these two helpers are being documented for the first time and they're deprecated, can we just drop them?
README.md
Outdated
| {{ amount_from_asset asset }} --> '2.001'. | ||
| ``` | ||
|
|
||
| * `symbol_name_from_asset` - _(__Deprecated__ Use `asset_to_symbol_code` instead.)_ Given a variable containing an asset, extract and return the symbol name. |
There was a problem hiding this comment.
Same question for this... drop it?
Mainly adds a section defining the available helpers and which version
of the spec they became available in.