Jira (PDOC-225) Data in Modules?
Title: Message Title R.I.Pienaar commented on PDOC-225 Re: Data in Modules? I have no ideas on how to do this with yard but details of the module supplied lookup options (merge strategies) would be amazing. 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-225) Data in Modules?
Title: Message Title
Henrik Lindberg commented on PDOC-225
Re: Data in Modules?
The yard syntax for parameter default could perhaps be used for this. The module author knows a parameter has a default value in hiera data in the module and could note that with some notation - yard does not have semantics for default for @param tags, but for @option it is suggested to place a default value in parentheses. We could use the same for @param. The convention could be () or say (module data) where the first documents a literal value for example (42), and the second that there will be a lookup and that the value is in the module's data (if possible user could also state what the default in module data is - if it always resolves to the same value - if so use something like (module data 42). Could also use (*) or somesuch to indicate "default in module data", but you have to know the notation to understand that.
# @param port [Integer] (*) the port to use
class myclass(Integer $port) { }
Nothing of the above requires any changes to code, only that a convention is established.
Add Comment
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Jira (PDOC-226) Support for Type Aliases
Title: Message Title
Henrik Lindberg commented on PDOC-226
Re: Support for Type Aliases
There are type aliases as the ones described in the linked documentation - i.e. an autoloaded data type alias like:
type MyModule::MyType = SomeOtherType
For those it would be great if an adjacent comment is taken as documentation of the aliased type. Note that for some such declarations - it is not as much an alias as a type definition - for example:
type MyModule::MyType = Object[{ attributes => { name => String, birthdate => Timestamp}}]
There are also local type aliases in 4.x ruby functions. More complex functions use those to define aliases that are only in effect for a single function. Here is an example from the lookup() function:
local_types do
type 'NameType = Variant[String, Array[String]]'
type 'ValueType= Type'
type 'DefaultValueType = Any'
type 'MergeType= Variant[String[1], Hash[String, Scalar]]'
type 'BlockType= Callable[NameType]'
Jira (PDOC-227) use markdown as default/only markup type
Title: Message Title Henrik Lindberg commented on PDOC-227 Re: use markdown as default/only markup type +100 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 (BOLT-57) Download a file
Title: Message Title Henrik Lindberg commented on BOLT-57 Re: Download a file Michael Smith What I proposed earlier was for rcp semantics (no copy from one remote to another). I like the idea of file_copy function with scp semantics, since you can then copy a file from/to any - including a copy on the local host between two paths. If scp can be used to perform an operation it could be used otherwise down/up-load needs to be performed. What I proposed was not "just copy" it also included semantics that files from remotes to local where copied to a location per target so that they do not step on each other (collection of "same file" from multiple remotes). Maybe that is a special case deserving its own function like collect_files which is implemented in terms of copy_file where copy_file just copies to/from as given by targets/paths? (Same thing is naturally achievable by passing options to copy_file). 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 (PUP-8482) Create a formal representation of the AST that can replace the current dump format
Title: Message Title
Henrik Lindberg updated an issue
Puppet / PUP-8482
Create a formal representation of the AST that can replace the current dump format
Change By:
Henrik Lindberg
Release Notes Summary:
The S-_expression_ (clojure style data) format generated by {{puppet parser dump}} has been formalized and updated and is now considered a supported API for tools integration. The new format is available in text form as well as a Json version using the flag {{\--format}} with either {{pn}} for the new format, or {{json}} for the new format in Json. The flag {{\--pretty}} will add line breaks and indentation for the purpose of increasing readability. The old format is still the default for {{puppet parser dump}} , but is deprecated and will be removed in the next major version of puppet.
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,
Jira (PUP-8482) Create a formal representation of the AST that can replace the current dump format
Title: Message Title Henrik Lindberg assigned an issue to Unassigned Puppet / PUP-8482 Create a formal representation of the AST that can replace the current dump format Change By: Henrik Lindberg Assignee: Henrik Lindberg 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.
