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

(doc) fix link to CONTRIBUTING / fix --emit-json option 

link to CONTRIBUTING was wrong.

example for json output has a missing yardoc option
This commit is contained in:
Jonas Genannt 2016-04-28 10:56:38 +02:00
parent f7cd0dabb0
commit 14631d81f9
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -11,7 +11,7 @@ A Puppet Face and plugin built on the [YARD Documentation Tool](http://yardoc.or
| *Issues* | [Puppet Labs' JIRA Tracker][JIRA] | | *Issues* | [Puppet Labs' JIRA Tracker][JIRA] |
| *License* | [Apache 2.0][LICENSE] | | *License* | [Apache 2.0][LICENSE] |
| *Change log* | [CHANGELOG.md][changelog] | | *Change log* | [CHANGELOG.md][changelog] |
| *Contributing* | [CONTRIBUTING.md][changelog] and [COMMITTERS.md][committers]| | *Contributing* | [CONTRIBUTING.md][contributing] and [COMMITTERS.md][committers]|
[repo]: https://github.com/puppetlabs/puppetlabs-strings [repo]: https://github.com/puppetlabs/puppetlabs-strings
[JIRA]: https://tickets.puppetlabs.com/browse/PDOC [JIRA]: https://tickets.puppetlabs.com/browse/PDOC
@ -82,13 +82,13 @@ $ puppet strings some_manifest.pp [another_if_you_feel_like_it.rb]
Strings can also emit the generated documentation as JSON: Strings can also emit the generated documentation as JSON:
``` ```
$ puppet strings some_manifest.pp --emit-json documentation.json $ puppet strings yardoc some_manifest.pp --emit-json documentation.json
``` ```
It can also print the JSON to stdout: It can also print the JSON to stdout:
``` ```
$ puppet strings some_manifest.pp --emit-json-stdout $ puppet strings yardoc some_manifest.pp --emit-json-stdout
``` ```
The schema for the JSON which Strings emits is [well documented](https://github.com/puppetlabs/puppetlabs-strings/blob/master/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).