Jira (PDOC-283) Yard gem 0.9.20 causes name spaced puppet functions to render wrong

5 views
Skip to first unread message

Cas Donoghue (JIRA)

unread,
Jun 28, 2019, 4:45:03 PM6/28/19
to puppe...@googlegroups.com
Cas Donoghue created an issue
 
Puppet Strings / Bug PDOC-283
Yard gem 0.9.20 causes name spaced puppet functions to render wrong
Issue Type: Bug Bug
Assignee: Unassigned
Created: 2019/06/28 1:44 PM
Priority: Normal Normal
Reporter: Cas Donoghue

Previously a function definition like Puppet::Functions.create_function(:'file::exists', Puppet::Functions::InternalFunction) do (https://github.com/puppetlabs/bolt/blob/2fc9eb44f0b743c8a07d7f165bf5c646aa142076/bolt-modules/file/lib/puppet/functions/file/exists.rb#L4) would have a function name of file::exists. With yard 0.9.20 and puppet strings 2.2.0 the function name renders as :'file::exists'. For example a call like https://github.com/puppetlabs/bolt/blob/2fc9eb44f0b743c8a07d7f165bf5c646aa142076/Rakefile#L62 will result in json like:

  "puppet_functions": [
    {
      "name": ":'ctrl::do_until'",
      "file": "bolt-modules/ctrl/lib/puppet/functions/ctrl/do_until.rb",
      "line": 4,
      "type": "ruby4x",
      "signatures": [
        {
          "signature": ":'ctrl::do_until'(Callable &$block)",
          "docstring": {
            "text": "Repeat the block until it returns a truthy value. Returns the value.",
            "tags": [
              {
                "tag_name": "example",
                "text": "ctrl::do_until() || {\n  run_task('test', $target, _catch_errors => true).ok?\n}",
                "name": "Run a task until it succeeds"
              },
              {
                "tag_name": "param",
                "text": "",
                "types": [
                  "Callable"
                ],
                "name": "&block"
              },
              {
                "tag_name": "return",
                "text": "",
                "types": [
                  "Any"
                ]
              }
            ]
          }
        }
      ],

Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo

Glenn Sarti (JIRA)

unread,
Jun 29, 2019, 4:29:02 AM6/29/19
to puppe...@googlegroups.com

Glenn Sarti (JIRA)

unread,
Jun 29, 2019, 4:30:03 AM6/29/19
to puppe...@googlegroups.com

Glenn Sarti (JIRA)

unread,
Jun 30, 2019, 9:46:02 PM6/30/19
to puppe...@googlegroups.com
Reply all
Reply to author
Forward
0 new messages