Jira (PDOC-295) Add support for @enum tag

2019-10-20 Thread Sean Millichamp (JIRA) 
Title: Message Title


 
 
 
 

 
 
 

 
   
 Sean Millichamp commented on  PDOC-295  
 

  
 
 
 
 

 
 
  
 
 
 
 

 
  Re: Add support for @enum tag
 

  
 
 
 
 

 
 A PR which I believe implements this correctly is up here for consideration: https://github.com/puppetlabs/puppet-strings/pull/215 Thanks!  
 

  
 
 
 
 

 
 
 

 
 
 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 view this discussion on the web visit https://groups.google.com/d/msgid/puppet-bugs/JIRA.330991.1571580412000.8564.1571580540040%40Atlassian.JIRA.

Jira (PDOC-295) Add support for @enum tag

2019-10-20 Thread Sean Millichamp (JIRA) 
Title: Message Title


 
 
 
 

 
 
 

 
   
 Sean Millichamp created an issue  
 

  
 
 
 
 

 
 
  
 
 
 
 

 
 Puppet Strings /  PDOC-295  
 
 
  Add support for @enum tag
 

  
 
 
 
 

 
Issue Type: 
  New Feature  
 
 
Assignee: 
 Unassigned  
 
 
Created: 
 2019/10/20 7:06 AM  
 
 
Priority: 
  Normal  
 
 
Reporter: 
 Sean Millichamp  
 

  
 
 
 
 

 
 Puppet Strings currently supports, via YARD, the ability to add extended documentation to a parameter which expects a hash to document the various keys expected using the @option tag. This is quite useful. Parameters that are of the Puppet Enum type would also benefit from this type of extended option documentation. However, the @option tag is not suitable as it expects a data type to be provided, which makes no sense in the context of an Enum. You can put an arbitrary value as the datatype, but it results in a poor user experience for both the person documenting and the person reading the documentation. Instead I propose adding a new tag, @enum, that behaves similarly to @option but does not expect a data type to be passed and renders the results accordingly (but otherwise similarly to @option).    
 

  
 
 
 
 

 
 
 

 
 
 Add Comment