kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(maint) Make some small updates to the README 

Update the README so that it is accurate
This commit is contained in:
Hailee Kenney 2015-10-19 11:53:52 -07:00
parent 93f0dd923b
commit 0deed02353
1 changed files with 1 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -102,7 +102,7 @@ It can also print the JSON to stdout:
$ puppet strings some_manifest.pp --emit-json-stdout
```
The schema for the JSON which Strings emits is [well documented](json_dom.md).
The schema for the JSON which Strings emits is [well documented](https://github.com/puppetlabs/puppetlabs-strings/blob/master/json_dom.md).
Processing is delegated to the `yardoc` tool so some options listed in `yard
help doc` are available. However, Puppet Faces do not support passing
@ -266,9 +266,6 @@ a best-effort basis, until the previous major version is no longer maintained.
Caveats
-------
- At the moment, only top-level Classes and Defined Types are parsed and
formatted.
- Documentation blocks must immediately precede the documented code with no
whitespace. This is because the comment extractor possesses the elegance
and intelligence of a bag of hammers.