Jira (PDOC-158) linting of missing @params

2018-03-05 Thread Eric Putnam (JIRA)
Title: Message Title


 
 
 
 

 
 
 

 
   
 Eric Putnam commented on  PDOC-158  
 

  
 
 
 
 

 
 
  
 
 
 
 

 
  Re: linting of missing @params   
 

  
 
 
 
 

 
 Joshua Hoblitt, another interesting suggestion. We are always accepting PRs! However, this may not be something that gets done by us in the near future.  
 

  
 
 
 
 

 
 
 

 
 
 Add Comment  
 

  
 

  
 
 
 
  
 

  
 
 
 
 

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

 
   
 

  
 

  
 

   





-- 
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.


Jira (PDOC-158) linting of missing @params

2017-01-13 Thread Joshua Hoblitt (JIRA)
Title: Message Title
 
 
 
 
 
 
 
 
 
 
  
 
 Joshua Hoblitt created an issue 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 Puppet Strings /  PDOC-158 
 
 
 
  linting of missing @params  
 
 
 
 
 
 
 
 
 

Issue Type:
 
  New Feature 
 
 
 

Assignee:
 

 Unassigned 
 
 
 

Created:
 

 2017/01/13 10:40 AM 
 
 
 

Environment:
 
 
puppet-strings-1.0.0 
 
 
 

Priority:
 
  Normal 
 
 
 

Reporter:
 
 Joshua Hoblitt 
 
 
 
 
 
 
 
 
 
 
When formatting, warnings are printed for missing `@param` tags out but the exit status of the `puppet strings` face seems to always been `0`. It would be very useful to have a mode that disabled formatted output and makes warnings fatal (`exit != 0`). This would enable usage in a CI "linting" workflow to catch missing documentation for new parameters. 
 
 
 
 
 
 
 
 
 
 
 
 

 
 Add Comment 
 
 
 
 
 
 
 
 
 
 

 
 
   

Jira (PDOC-158) linting of missing @params

2017-01-13 Thread Joshua Hoblitt (JIRA)
Title: Message Title
 
 
 
 
 
 
 
 
 
 
  
 
 Joshua Hoblitt updated an issue 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 Puppet Strings /  PDOC-158 
 
 
 
  linting of missing @params  
 
 
 
 
 
 
 
 
 

Change By:
 
 Joshua Hoblitt 
 
 
 
 
 
 
 
 
 
 When formatting, warnings are printed for missing `@param` tags out but the exit status of the `puppet strings` face seems to always  been  be  `0`.  It would be very useful to have a mode that disabled formatted output and makes warnings fatal (`exit  != 0`).  This would enable usage in a CI "linting" workflow to catch missing documentation for new parameters. 
 
 
 
 
 
 
 
 
 
 
 
 

 
 Add Comment 
 
 
 
 
 
 
 
 
 
 

 
 
 
 
 
 
 
 
 
 

 This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) 
 
 
 
 
  
 
 
 
 
 
 
 
 
   





-- 
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.