Commit Graph

4 Commits

Author SHA1 Message Date
Peter Huene ea9dd0c846
(PDOC-63) Delete the old implementation.
This commit deletes the old implementation to assist in cleaner code reviews of
the upcoming reimplementation.

This commit also moves YARD to version 0.9.5 and lays down a bare bones
implementation of Puppet Strings that currently does nothing.
2016-09-15 13:54:18 -07:00
Peter Huene 56f266db4b
(maint) Rename puppetlab-strings to puppet-strings where appropriate.
This commit changes the source and documentation to reference this project as
`puppet-strings` rather than `puppetlabs-strings`.

This makes the source and project match the gem name.
2016-09-14 13:42:28 -07:00
Hailee Kenney eafe3eaa32 (maint) Exclude files that cause YARD errors
Running `puppet strings server` generates documentation for all
modules in your modulepath, meaning that it also generates HTML
for strings itself. Since there are parts of strings that are not
meant to be documented with YARD, exclude the files that cause
error messages so that `puppet strings server` is not needlessly
noisy.

Additionally, make a few suggested changes to the README to make
it clearer and easier to read.
2014-10-20 17:37:49 -07:00
Charlie Sharpsteen 47d0cbe356 Exclude YARD templates directory from yard doc
The templates directory is full of stuff that `yard doc` can't process. This
causes a bunch of ugly warnings to flash across the screen.
2014-06-10 20:38:01 -07:00