On Wed, Jul 20, 2011 at 11:42 AM, Nick Fagerlund <
nick.fagerl...@puppetlabs.com> wrote:
> On Jul 20, 8:17 am, Jacob Helwig <ja...@puppetlabs.com> wrote:
> > I can see adding a note something like "separated by the
> > '#{File::PATH_SEPARATOR}' character (varies by platform).", but I'd
> > really rather not have us listing out both ';' and ':'.
> >
> > The bigger problem is that we're trying to serve two different purposes
> > with the same text. We're trying to have generic documentation suitable
> > for the web, and also have the documentation that is relevent for the
> > specific platform that we're actually running on.
>
> Unless someone can get me some numbers or some very convincing
> anecdotes about # of people who know about genconfig vs. # of people
> who know docs exist on the web somewhere, yr. writer is decreeing that
> the generic case is more important and we should err on the side of
> generating accurate web text.
>
> In this case, I'm proposing the following:
>
> :desc => "The search path for modules, as a series of directories
> separated by `:` (on Unix-like systems) or `;` (on Windows).",
>
> There are only two path separators in active use, it's not a big deal
> to call out both of them. The other suggestions are worse. Any
> objections?
Seems fine to me and similar to the approach taken by that other programming
language:
http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html#pathSeparatorChar
Josh
--
You received this message because you are subscribed to the Google Groups
"Puppet Developers" group.
To post to this group, send email to puppet-dev@googlegroups.com.
To unsubscribe from this group, send email to
puppet-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/puppet-dev?hl=en.
