From 0deed02353b7c2a03112073a77ed1c254d378c07 Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Mon, 19 Oct 2015 11:53:52 -0700 Subject: [PATCH] (maint) Make some small updates to the README Update the README so that it is accurate --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 22a74d4..21daabe 100644 --- a/README.md +++ b/README.md @@ -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.