HomePhorge

(maint) Partial cleanup of the parameters/properties/attributes documentation
6d47ff6d120fUnpublished

Unpublished Commit ยท Learn More

Repository Importing: This repository is still importing.

Description

(maint) Partial cleanup of the parameters/properties/attributes documentation

The concepts of properties vs. parameters (vs. metaparameters) and the
generic term "attributes" has been confused in various bits of documentation
of the Puppet::Type base class for resource types.

Clear up some of the comments by making appropriate use of these terms:

  • properties for attributes that are no parameters
  • parameters for attributes that are no properties
  • attributes if both are encompassed

Metaparameters are really just a special case of parameters. They should be
included when properties and parameters are enumerated instead of
just refering to "attributes".

It's also worth to note that since parameters and properties don't share
a common base class (Puppet::Attribute?), a method return or parameter type
that can be either cannot be made more specific than "Object", e.g.

return [Object] the named attribute

Details

Provenance
Felix Frank <Felix.Frank@Alumni.TU-Berlin.de>Authored on
vanmeeuwenPushed on Jun 2 2015, 2:22 PM
Parents
rPUdc8969003ab0: (maint) establish the synonym "composite key" for uniqueness key
Branches
Unknown
Tags
Unknown

Event Timeline

Felix Frank <Felix.Frank@Alumni.TU-Berlin.de> committed rPU6d47ff6d120f: (maint) Partial cleanup of the parameters/properties/attributes documentation (authored by Felix Frank <Felix.Frank@Alumni.TU-Berlin.de>).Jun 3 2014, 1:15 AM