Project

General

Profile

Actions

Feature #16858

closed

Parse YARD parameter documentation when available

Added by Dominic Cleal over 7 years ago. Updated over 7 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Difficulty:
Triaged:
Fixed in Releases:
Found in Releases:

Description

The Puppet Strings JSON output contains per-parameter documentation when given in a YARD format, e.g.

@param example Description of the example parameter

This is exported as:

"tags": [
  {
    "tag_name": "param",
    "text": "Description of the example parameter",
    "types": [
      "..." 
    ],
    "name": "example" 
  }
]

When using this format, the main class docstring wouldn't contain any RDoc either, it would be plain text (possibly with Markdown).

No grouping is supported at the moment (PDOC-123) but the type and conditional could be parsed out of the per-parameter doc string using the same format used in the current RDoc style.

Actions #1

Updated by The Foreman Bot over 7 years ago

  • Status changed from Assigned to Ready For Testing
  • Pull request https://github.com/theforeman/kafo_parsers/pull/32 added
Actions #2

Updated by Dominic Cleal over 7 years ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100
Actions

Also available in: Atom PDF