Commit Graph

517 Commits

Author SHA1 Message Date
Garrett Guillotte f6fcd7e1b4 Fix markdown for code blocks in a README list 2017-05-25 11:18:17 -07:00
Jesse Scott 492700a15b Merge pull request #140 from maju6406/patch-1
(maint) Fixing markdown formatting errors
2017-05-22 11:34:08 -07:00
Jesse Scott 1f4bab28d1 Merge pull request #141 from hfm/master
fix typo
2017-05-22 11:33:31 -07:00
OKUMURA Takahiro 928bb23f55
fix typo 2017-05-21 03:37:26 +09:00
Abir Majumdar a36ce30ba6 (maint) Fixing markdown formatting errors
Github markdown needs a space after a #
2017-03-20 14:58:22 -07:00
Will Hopper eaa3d58659 (PDOC-165) Bump version to 1.1.0 and update CHANGELOG 2017-03-20 11:45:17 -07:00
Jesse Scott ba1a653331 Merge pull request #138 from whopper/PDOC-161/master/summary
(PDOC-161) Add `summary` tag for short descriptions
2017-03-16 14:45:49 -07:00
Will Hopper a3f00d043f (maint) Update outdated rubocop checks 2017-03-16 14:22:07 -07:00
Will Hopper 8178c0beff (PDOC-161) Update README with an example usage of the summary tag 2017-03-16 12:51:56 -07:00
Will Hopper 4990576f61 (PDOC-161) Add `summary` tag for short descriptions
This tag is primarily meant to be applied to Puppet classes,
but it is also supported by every other construct that can be
documented with strings.
2017-03-16 12:51:53 -07:00
Will Hopper d334ef78c0 Merge pull request #135 from er0ck/acceptance/master/PDOC-144-acceptance_fix_windows_pre-suite
(pdoc-144) acceptance: fix windows pre suite
2017-02-06 17:07:50 -08:00
Eric Thompson 564a6fb7f3 (PDOC-144) fix recent commit's Rakefile changes when no platform is specified 2017-02-07 01:05:43 +00:00
Eric Thompson 7bc5fb7f7f (PDOC-144) acceptance: fix windows pre-suite
* install the correct CAs in the correct places so windows can install gems
* use a gem_command abstraction to find the correct puppet gem exe

[skip ci]
2017-02-07 00:35:33 +00:00
Eric Thompson 5908cc795d (PDOC-144) acceptance: fix windows pre-suite
* windows install requires type=aio so gem_command can find the right gem exe
* this change also allows easier command line use
  * by using a sensible default for the acceptance key

[skip ci]
2017-02-07 00:32:58 +00:00
Jesse Scott 5682ffa915 Merge pull request #134 from whopper/maint/add_maintainters
(maint) Add MAINTAINERS file
2017-01-11 13:20:58 -08:00
Will Hopper 6c8246ff11 (maint) Add MAINTAINERS file 2017-01-11 12:55:47 -08:00
Hailee Kenney ba4619e345 Merge pull request #132 from whopper/PDOC-155/master/pup4_type_doc
(PDOC-155) Allow type documentation in Puppet 4 code
2017-01-10 14:15:18 -08:00
Will Hopper 2d0a1f0c70 (maint) Put provider command in quotes in JSON test 2017-01-10 13:59:41 -08:00
Will Hopper 165170c08b (PDOC-155) Allow type documentation in Puppet 4 code
Because Puppet 4 is typed, parameter type information can
be automatically determined without any explicit documentation
in @param tags. However, users may desire to do so anyway for
consistency. This commit allows @param tags to include a [type]
in Puppet 4 code. Strings will emit a warning if the documented
type does not match the actual type. In such an event, the incorrect
documented type will be ignored in favor of the real one.
2017-01-10 13:59:38 -08:00
Hailee Kenney 5b7ee1901f Merge pull request #133 from whopper/maint/yard-0.9.5
(maint) Pin YARD to 0.9.5
2017-01-10 12:26:07 -08:00
Will Hopper 8ec6a68d98 (maint) Pin YARD to 0.9.5
There is currently a parsing bug in YAD 0.9.6 and above
which causes errors on certain strings with '/' characters.
We'll pin to YARD 0.9.5 until the issue is resolved on YARD's
side.

See https://github.com/lsegal/yard/issues/1054.
2017-01-10 12:24:05 -08:00
Jesse Scott 2710e7a8e9 Merge pull request #131 from HAIL9000/maint/master/correct_param_tag_example
(maint) Fix @param type examples in README
2016-12-20 12:45:42 -08:00
Hailee Kenney 303c1eda1f (maint) Fix @param type examples in README
Correct the examples of using a parameter type in the @param tag
so that they match how the YARD documentation suggests the tag
should be used.

http://www.rubydoc.info/gems/yard/file/docs/Tags.md#param
2016-12-20 11:43:14 -08:00
Jesse Scott 5ae446fcba Merge pull request #130 from whopper/PDOC-143/windows-readme
(PDOC-143) Add installation instructions for PE 3.8 in Windows
2016-12-02 12:17:03 -08:00
Will Hopper 30ffd147f1 (maint) Turn off unnecessary rubocop Bundler warnings 2016-12-02 11:38:40 -08:00
Will Hopper 9d18af4114 (PDOC-143) Add installation instructions for PE 3.8 in Windows 2016-12-02 11:19:56 -08:00
Jesse Scott 1bd8575acb Merge pull request #129 from whopper/PDOC-107/1.0-release
(PDOC-137) Bump version to 1.0.0 and update CHANGELOG
2016-11-28 12:35:12 -08:00
Will Hopper 0123e8f79b (PDOC-137) Bump version to 1.0.0 and update CHANGELOG 2016-11-28 12:28:12 -08:00
Will Hopper 94605205b3 Merge pull request #128 from jbondpdx/master
(PDOC-133) revise+edit strings readme
2016-11-23 13:58:20 -08:00
jbondpdx 1f9a99a37a (PDOC-133) Edits to Strings README 2016-11-23 12:55:55 -08:00
Jesse Scott 95df5e6fa9 Merge pull request #127 from whopper/PDOC-125/acceptance
(PDOC-125) Update JSON acceptance test with signatures changes
2016-11-15 11:18:27 -08:00
Will Hopper bb9db53702 (PDOC-125) Update JSON acceptance test with signatures changes 2016-11-15 11:01:12 -08:00
Jesse Scott 6c35f889d4 Merge pull request #119 from whopper/PDOC-125/master/overload_refactor
(PDOC-125) Display all puppet function signatures in top-level signature key
2016-11-14 14:16:06 -08:00
Will Hopper f8c5628b66 (PDOC-125) Update JSON schema to reflect addition of `signatures` 2016-11-14 13:22:42 -08:00
Will Hopper e4df165489 (PDOC-125) Update JSON tests for `signatures` key 2016-11-14 13:05:07 -08:00
Will Hopper 6ad74b0500 (PDOC-125) Display all puppet function signatures in top-level signature array
This commit adds a new top-level key to the JSON schema for Ruby 3x/4x
puppet functions: `signatures`. This key is an array and is constructed entirely
with data from existing elements of the puppet function object. The data
structure itself remains unchanged, as this commit only affects the final
JSON output for functions.

In the case of a puppet 4x function with multiple dispatches (overloads),
the signatures key is populated with the equivalent of an overload tag
for each which includes the signature and any param or return tags for
the dispatch.

In the case of a puppet function with only one dispatch, the array is
simply populated with a single element containing a lone dispatch
and its param and return tags.

Note that this change does not affect the internal structure or
representation of puppet function objects, but rather only affects
its final display form when serialized into JSON. All prior data
has been left intact, and the only change here is the addition
of the `signatures` member to the JSON output.
2016-11-14 12:53:49 -08:00
Jesse Scott 70d5b1ccd7 Merge pull request #122 from whopper/PDOC-129/master/overload-empty-docstring
(PDOC-129) Include tags in overload objects when serialized as JSON
2016-11-14 12:51:38 -08:00
Will Hopper c56d9c60a4 (PDOC-129) Include tags in overload objects when serialized as JSON
Previously, overload objects were not displaying their tags when
they had no docstring text. This was due to an issue in the overload
`to_hash` method, which prevented the tags from being serialized when
the dispatch had no top-level text. This commit updates that logic
so that the tags will always be included in the hash if they exist.
2016-11-14 11:45:45 -08:00
Jesse Scott df8e58b0c8 Merge pull request #125 from whopper/PDOC-135/4x_dispatch_return_type
(PDOC-135) Detect `return_type` calls in 4.x function dispatches
2016-11-14 11:37:05 -08:00
Jesse Scott bf68ae0022 Merge pull request #126 from whopper/PDOC-136/3x_function_return
(PDOC-136) Detect return type syntax in Puppet Language functions
2016-11-14 11:36:40 -08:00
Will Hopper 36bc0dd98c (PDOC-135) Detect `return_type` calls in 4.x function dispatches
Previously, Strings ignored calls to `return_type` in Puppet 4.x API
function dispatches, preventing the return types of overloads from
being automatically determined. This commit adds a check for a node
with a `return_type` call and handles it properly.
2016-11-14 11:04:41 -08:00
Jesse Scott 7d5dd68593 Merge pull request #124 from puppetlabs/turbodog-patch-1
Update README install instructions for PE
2016-11-11 16:31:39 -08:00
Will Hopper 06617469c4 (maint) Run spec tests against Puppet 4.8 2016-11-11 14:48:02 -08:00
Will Hopper b3c8d52b25 (PDOC-136) Detect return type syntax in Puppet language functions
Previously, Strings ignored the return type in Puppet language functions
that used the following syntax:

function foo() >> String {}

This commit updates the FunctionStatement class to use the return
type from such a statement if it exists. In addition, Strings will
now emit a warning if the return type specified in the @return tag
doesn't match the type specified in the function definition.
2016-11-11 14:47:35 -08:00
Lindsey Smith de4bd41193 Update README install instructions for PE
Update the install instructions for the versions of Puppet Enterprise that contain Puppet 4.x
2016-11-09 17:37:51 -08:00
Jesse Scott c1dfeb9864 Merge pull request #123 from whopper/PDOC-93/search_bar_css
(PDOC-93) Ensure search bar doesn't overlap item list in nav bar
2016-11-07 16:47:20 -08:00
Will Hopper 46af92731d (PDOC-93) Ensure search bar doesn't overlap item list in nav bar 2016-11-07 14:23:45 -08:00
Jesse Scott 2e64a37327 Merge pull request #121 from whopper/PDOC-121/master/gh_pages_sha
(PDOC-121) Include tag or SHA in gh_pages task commit
2016-11-03 13:51:53 -07:00
Will Hopper 05806e7aee (PDOC-121) Include tag or SHA in gh_pages task commit
This commit updates the gh_pages task to reference the SHA
of the branch being documented in the documentation commit.

In addition, the description of each task except `update`
has been removed, as they are not useful on their own and
should be considered private. This is necessary in order
to hide the tasks from the output of `rake -T`.
2016-11-03 13:41:20 -07:00
Will Hopper 5427ee859f Merge pull request #116 from ghoneycutt/improve_testing
Test against specific, supported versions of Puppet
2016-11-02 11:10:46 -07:00