Skip to content

Commit

Permalink
More documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
edemaine committed Dec 29, 2016
1 parent 643fc23 commit 6c5563e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ you can install this tool via
The command-line arguments consist mostly of mapping and/or drawing files.
The files and other arguments are processed *in order*, so for example a
drawing can use all mapping files specified *before* it on the command line.
In the same symbol is defined by multiple mapping files, later mappings take
If the same symbol is defined by multiple mapping files, later mappings take
precedence (overwriting previous mappings).

Here is the output of `svgtiler --help`:
Expand Down Expand Up @@ -198,7 +198,9 @@ SYMBOL specifiers:
'filename.svg': load SVG from specifies file
'<svg>...</svg>': raw SVG
(context) -> ...: function computing SVG
-> ...@key...: function computing SVG, with `this` bound to Context with
`key` set to symbol name, `i` and `j` set to coordinates,
and supporting `neighbor` and `includes` methods.
```

## About
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "svgtiler",
"description": "Tool for drawing diagrams on a grid, combining grids of SVGs into a big SVG figure",
"version": "1.0.10",
"version": "1.0.11",
"repository": {
"type": "git",
"url": "git+https://github.com/edemaine/svg-tiler.git"
Expand Down
5 changes: 4 additions & 1 deletion src/svgtiler.coffee
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,7 @@ extension_map =
help = ->
console.log """
Usage: #{process.argv[1]} (...options and filenames...)
Documentation: https://github.com/edemaine/svgtiler#svg-tiler
Optional arguments:
--help Show this help message and exit.
Expand All @@ -454,7 +455,9 @@ SYMBOL specifiers:
'filename.svg': load SVG from specifies file
'<svg>...</svg>': raw SVG
-> ...: function computing SVG, with context available as this/@
-> ...@key...: function computing SVG, with `this` bound to Context with
`key` set to symbol name, `i` and `j` set to coordinates,
and supporting `neighbor` and `includes` methods.
"""
#object with one or more attributes
process.exit()
Expand Down

0 comments on commit 6c5563e

Please sign in to comment.