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

(PDOC-28) Being picky about spacing

This commit is contained in:
David Danzilio 2015-09-02 16:11:41 -04:00
parent 0dc8d95ce4
commit 3974d20612
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
README.md
View File

@ -77,8 +77,8 @@ Running Puppet Strings
Once strings has been installed you can document a puppet module: Once strings has been installed you can document a puppet module:
``` ```
$ cd /path/to/module $ cd /path/to/module
$ puppet strings $ puppet strings
``` ```
This processes `README` and all puppet and ruby files under `manifests/` This processes `README` and all puppet and ruby files under `manifests/`
@ -87,7 +87,7 @@ and `lib/`.
To document specific files: To document specific files:
``` ```
$ puppet strings some_manifest.pp [another_if_you_feel_like_it.rb] $ puppet strings some_manifest.pp [another_if_you_feel_like_it.rb]
``` ```
Processing is delegated to the `yardoc` tool so some options listed in `yard Processing is delegated to the `yardoc` tool so some options listed in `yard
@ -99,7 +99,7 @@ In addition to generating a directory full of HTML, you can also serve up
documentation for all your modules using the `server` action: documentation for all your modules using the `server` action:
``` ```
$ puppet strings server $ puppet strings server
``` ```
Writing Compatible Documentation Writing Compatible Documentation
@ -113,7 +113,7 @@ would like YARD to use by adding a `.yardopts` file to the root of your module
directory which specifies the desired format: directory which specifies the desired format:
``` ```
--markup markdown --markup markdown
``` ```
While we have yet to decide exactly how documentation should work in the While we have yet to decide exactly how documentation should work in the
@ -125,22 +125,22 @@ style guide.
Here's an example of how you might document a 4x function: Here's an example of how you might document a 4x function:
```ruby ```ruby
# When given two numbers, returns the one that is larger. # When given two numbers, returns the one that is larger.
# You could have a several line description here if you wanted, # You could have a several line description here if you wanted,
# but I don't have much to say about this function. # but I don't have much to say about this function.
# #
# @example using two integers # @example using two integers
# $bigger_int = max(int_one, int_two) # $bigger_int = max(int_one, int_two)
# #
# @return [Integer] the larger of the two parameters # @return [Integer] the larger of the two parameters
# #
# @param num_a [Integer] the first number to be compared # @param num_a [Integer] the first number to be compared
# @param num_b [Integer] the second number to be compared # @param num_b [Integer] the second number to be compared
Puppet::Functions.create_function(:max) do Puppet::Functions.create_function(:max) do
def max(num_a, num_b) def max(num_a, num_b)
num_a >= num_b ? num_a : num_b num_a >= num_b ? num_a : num_b
end end
end end
``` ```
### Classes / Defined Types ### Classes / Defined Types
@ -148,19 +148,19 @@ Here's an example of how you might document a 4x function:
Here's an example of how you might document a class: Here's an example of how you might document a class:
```puppet ```puppet
# This class is meant to serve as an example of how one might # This class is meant to serve as an example of how one might
# want to document a manifest in a way that is compatible. # want to document a manifest in a way that is compatible.
# with the strings module # with the strings module
# #
# @example when declaring the example class # @example when declaring the example class
# include example # include example
# #
# @param first_arg The first parameter for this class # @param first_arg The first parameter for this class
# @param second_arg The second paramter for this class # @param second_arg The second paramter for this class
class example ( class example (
$first_arg = $example::params::first_arg, $first_arg = $example::params::first_arg,
$second_arg = $exampe::params::second_arg, $second_arg = $exampe::params::second_arg,
) { } ) { }
``` ```
### Types and Providers ### Types and Providers
@ -210,13 +210,13 @@ Rake Tasks
This module is also available as a Gem and makes two rake tasks (`generate` and `serve`) available in `puppet-strings/rake_tasks`. To add this to your module's CI workflow, be sure to add this module to your `Gemfile`: This module is also available as a Gem and makes two rake tasks (`generate` and `serve`) available in `puppet-strings/rake_tasks`. To add this to your module's CI workflow, be sure to add this module to your `Gemfile`:
```ruby ```ruby
gem 'puppetlabs-strings', :git => 'https://github.com/puppetlabs/puppet-strings.git' gem 'puppetlabs-strings', :git => 'https://github.com/puppetlabs/puppet-strings.git'
``` ```
To use the rake tasks, `require puppet-strings/rake_tasks` in your `Rakefile`: To use the rake tasks, `require puppet-strings/rake_tasks` in your `Rakefile`:
```ruby ```ruby
require 'puppet-strings/rake_tasks' require 'puppet-strings/rake_tasks'
``` ```
Developing and Contributing Developing and Contributing