Permalink
Browse files

README typos

  • Loading branch information...
Daniel Shannon
Daniel Shannon committed Jul 18, 2013
1 parent 95723e1 commit 509a11e1596bef4879c11613e1384806966a1781
Showing with 2 additions and 2 deletions.
  1. +2 −2 README.mdown
@@ -29,9 +29,9 @@ These are intended to make some basic rote tasks easier and faster to code. alp
* `alp.local(join=None)`, `alp.cache(join=None)`, `alp.storage(join=None)`
These functions return the paths to, respectively, the workflow's local directory, the workflow's designated cache (volatile storage) directory, and the workflow's designated storage (nonvolatile storage) directory. The directories will be created if they do not exist. By specifying an argument for `join`, you can have a file or folder name appended to the path---however, _this file or folder will not be created_.
* `alp.readPlist(path)`, `alp.writePlist(path)`, `alp.jsonLoad(path, default=None)`, `alp.jsonDump(path)`
These functions will read from and write to the plist or JSON files located at `path`. If `path` is not an absolute path, they will treat it as a filename in the storage directory (so, for example, you could call `alp.jsonDump("dump.json")` without any problems. `jsonLoad` has one additional argument, `default`, specifying the object to be dumped and returned if the JSON file did not already exist. For example, calling `alp.jsonLoad("foo.json", [])` would load `foo.json` with an empty list if the file was not found.
These functions will read from and write to the plist or JSON files located at `path`. If `path` is not an absolute path, they will treat it as a filename in the storage directory (so, for example, you could call `alp.jsonDump(yourFancyObject, "dump.json")` without any problems. `jsonLoad` has one additional argument, `default`, specifying the object to be dumped and returned if the JSON file did not already exist. For example, calling `alp.jsonLoad("foo.json", default=[])` would load `foo.json` with an empty list if the file was not found.
* `alp.find(query)`
Calls `mdfind` with the arguments given in `query`. For more information, see [`mdfind (1)`](https://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/mdfind.1.html).
Calls `mdfind` with the arguments given in `query`, splitting the results into a list and returning it. For more information, see [`mdfind (1)`](https://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man1/mdfind.1.html).
* `alp.log(s)`
Writes `s` to a file called `debug.log` in the workflow's main folder.

0 comments on commit 509a11e

Please sign in to comment.