<feed xmlns='http://www.w3.org/2005/Atom'>
<title>puppet.git/lib/puppet/face/catalog, branch master</title>
<subtitle>Puppet repo</subtitle>
<link rel='alternate' type='text/html' href='https://fedorapeople.org/cgit/ricky/public_git/puppet.git/'/>
<entry>
<title>(#7764, 7775, 7778) Revisions to Faces help text</title>
<updated>2011-06-07T21:08:39+00:00</updated>
<author>
<name>nfagerlund</name>
<email>nick.fagerlund@gmail.com</email>
</author>
<published>2011-06-03T17:28:52+00:00</published>
<link rel='alternate' type='text/html' href='https://fedorapeople.org/cgit/ricky/public_git/puppet.git/commit/?id=17723634875e308b2752efed8ebdfd3db3239215'/>
<id>17723634875e308b2752efed8ebdfd3db3239215</id>
<content type='text'>
Per UX review of help text, this commit makes several changes over the breadth
of the Faces help:

* Preface API-only action summaries/descriptions with "API only." (issue #7775)
* Provide both CLI and API info in "returns," with the CLI info first. (issue #7778)
* Summaries should be sentences. (Add punctuation.)
* First sentences of descriptions should reiterate summaries. (Summaries and
  descriptions should be displayed far enough apart that this isn't a problem.)
* Standardize on "subcommand" instead of "face" when talking about the entity
  you invoke at the command line. (Use "face" when describing API use.)
* Fix outdated or clunky text in several faces.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Per UX review of help text, this commit makes several changes over the breadth
of the Faces help:

* Preface API-only action summaries/descriptions with "API only." (issue #7775)
* Provide both CLI and API info in "returns," with the CLI info first. (issue #7778)
* Summaries should be sentences. (Add punctuation.)
* First sentences of descriptions should reiterate summaries. (Summaries and
  descriptions should be displayed far enough apart that this isn't a problem.)
* Standardize on "subcommand" instead of "face" when talking about the entity
  you invoke at the command line. (Use "face" when describing API use.)
* Fix outdated or clunky text in several faces.
</pre>
</div>
</content>
</entry>
<entry>
<title>(#7561) Complete help text for all faces and actions</title>
<updated>2011-05-26T23:04:42+00:00</updated>
<author>
<name>nfagerlund</name>
<email>nick.fagerlund@gmail.com</email>
</author>
<published>2011-05-18T23:20:05+00:00</published>
<link rel='alternate' type='text/html' href='https://fedorapeople.org/cgit/ricky/public_git/puppet.git/commit/?id=331d8128288f8c7bb3645149ff452372c0866429'/>
<id>331d8128288f8c7bb3645149ff452372c0866429</id>
<content type='text'>
Faces help output relies on input from the documentation methods in each
of the faces to be documented. This commit calls those methods in each of our
faces, with varying levels of detail depending on their complexity.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Faces help output relies on input from the documentation methods in each
of the faces to be documented. This commit calls those methods in each of our
faces, with varying levels of detail depending on their complexity.
</pre>
</div>
</content>
</entry>
<entry>
<title>(Maint) Adjust documentation whitespace</title>
<updated>2011-05-04T23:11:39+00:00</updated>
<author>
<name>nfagerlund</name>
<email>nick.fagerlund@gmail.com</email>
</author>
<published>2011-05-04T23:11:39+00:00</published>
<link rel='alternate' type='text/html' href='https://fedorapeople.org/cgit/ricky/public_git/puppet.git/commit/?id=7b71745ac4507375fc452d87e5130e504cef53c8'/>
<id>7b71745ac4507375fc452d87e5130e504cef53c8</id>
<content type='text'>
The patch from issue #7221 permits indented heredocs. This patch takes advantage
of that to make the doc strings less messy.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
The patch from issue #7221 permits indented heredocs. This patch takes advantage
of that to make the doc strings less messy.
</pre>
</div>
</content>
</entry>
<entry>
<title>(#6962) Add self-documentation data to puppet faces</title>
<updated>2011-05-04T23:01:49+00:00</updated>
<author>
<name>nfagerlund</name>
<email>nick.fagerlund@gmail.com</email>
</author>
<published>2011-04-27T17:46:47+00:00</published>
<link rel='alternate' type='text/html' href='https://fedorapeople.org/cgit/ricky/public_git/puppet.git/commit/?id=dce072a87c0a47b4edc76ca988029ee8b626eeb6'/>
<id>dce072a87c0a47b4edc76ca988029ee8b626eeb6</id>
<content type='text'>
This patch adds documentation strings to most of the faces, actions, and options
introduced in 2.7.0. There are a small number of TK notes remaining, and longer strings
have not been indented to take advantage of the patch from issue #7221.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This patch adds documentation strings to most of the faces, actions, and options
introduced in 2.7.0. There are a small number of TK notes remaining, and longer strings
have not been indented to take advantage of the patch from issue #7221.
</pre>
</div>
</content>
</entry>
<entry>
<title>(#7353) Use :console rendering format in our own code.</title>
<updated>2011-05-04T19:28:41+00:00</updated>
<author>
<name>Daniel Pittman</name>
<email>daniel@puppetlabs.com</email>
</author>
<published>2011-05-04T17:38:36+00:00</published>
<link rel='alternate' type='text/html' href='https://fedorapeople.org/cgit/ricky/public_git/puppet.git/commit/?id=efd118114bab228b5f8f4a437ead8be2cc895d8a'/>
<id>efd118114bab228b5f8f4a437ead8be2cc895d8a</id>
<content type='text'>
Now that we have unified things, stop using the compatibility name in favour
of the new :console name for the output format.  No functional effect beyond
avoiding a deprecated output mode.

Reviewed-By: Jacob Helwig &lt;jacob@puppetlabs.com&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Now that we have unified things, stop using the compatibility name in favour
of the new :console name for the output format.  No functional effect beyond
avoiding a deprecated output mode.

Reviewed-By: Jacob Helwig &lt;jacob@puppetlabs.com&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>(#7278) Improve utility of the Catalog select action</title>
<updated>2011-05-03T19:56:11+00:00</updated>
<author>
<name>Luke Kanies</name>
<email>luke@puppetlabs.com</email>
</author>
<published>2011-04-27T22:04:20+00:00</published>
<link rel='alternate' type='text/html' href='https://fedorapeople.org/cgit/ricky/public_git/puppet.git/commit/?id=48903f58e535dabd55b6895eae1dc1967553391a'/>
<id>48903f58e535dabd55b6895eae1dc1967553391a</id>
<content type='text'>
This extends the catalog select action to be able to return more than a single
type, as well as supporting both programmatic and human focused rendering of
the return value.

Reviewed-By: Daniel Pittman &lt;daniel@puppetlabs.com&gt;
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This extends the catalog select action to be able to return more than a single
type, as well as supporting both programmatic and human focused rendering of
the return value.

Reviewed-By: Daniel Pittman &lt;daniel@puppetlabs.com&gt;
</pre>
</div>
</content>
</entry>
<entry>
<title>(#7056) Use 'face' rather than 'faces' in the production code.</title>
<updated>2011-04-13T07:17:57+00:00</updated>
<author>
<name>Daniel Pittman</name>
<email>daniel@puppetlabs.com</email>
</author>
<published>2011-04-13T07:17:57+00:00</published>
<link rel='alternate' type='text/html' href='https://fedorapeople.org/cgit/ricky/public_git/puppet.git/commit/?id=4dd6a77481400b7eeac3377267d092d4c6d22da3'/>
<id>4dd6a77481400b7eeac3377267d092d4c6d22da3</id>
<content type='text'>
After some discussion we decided that most uses of the Puppet Face
infrastructure were about single faces on their own, not about the collection,
and so we were better referring to Puppet::Face[...] in code.

This implements that by translating names and references in the Ruby code to
the new, s-less, name.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
After some discussion we decided that most uses of the Puppet Face
infrastructure were about single faces on their own, not about the collection,
and so we were better referring to Puppet::Face[...] in code.

This implements that by translating names and references in the Ruby code to
the new, s-less, name.
</pre>
</div>
</content>
</entry>
</feed>
