Ticket #1022 (new todo)

Opened 5 years ago

Last modified 3 years ago

PGE::Glob needs docs.

Reported by: coke Owned by:
Priority: minor Milestone:
Component: docs Version: trunk
Severity: low Keywords:
Cc: Language:
Patch status: Platform:

Description

PGE::Glob should have POD docs explaining the specific matching language that is used. See Tcl::Glob for an example.

This will help clarify that there are two different syntaxes available.

Change History

in reply to: ↑ description   Changed 3 years ago by jkeenan

Replying to coke:

PGE::Glob should have POD docs explaining the specific matching language that is used. See Tcl::Glob for an example. This will help clarify that there are two different syntaxes available.

Coke, I found very few differences between the PODs of these two files. The Tcl::Glob file has this section:

    The following special characters are supported

    "?" Matches any single character

    "*" Matches any number of any characters, including no characters.

    "[chars]"
        Matches any character in the given set. Sets are either a sequence
        of explicit characters, or a range specified with a dash, e.g.
        [aeiou] matches lower case ASCII vowels, while [a-z] matches any
        lowercase ASCII letter.

    "\x"
        Match a literal character, e.g. \* matches the literal "*", avoiding
        its special meaning.

... which has no counterpart in the PGE::Glob file. But otherwise, PGE::Glob looks well documented.

Can you explain a bit more about what you think is missing?

Thank you very much.

kid51

  Changed 3 years ago by coke

On Tue, Jan 25, 2011 at 9:30 PM, Parrot <parrot-tickets@lists.parrot.org> wrote:
> #1022: PGE::Glob needs docs.
> -------------------+--------------------------------------------------------
>  Reporter:  coke   |       Owner:
>     Type:  todo   |      Status:  new
>  Priority:  minor  |   Milestone:
> Component:  docs   |     Version:  trunk
>  Severity:  low    |    Keywords:
>     Lang:         |       Patch:
>  Platform:         |
> -------------------+--------------------------------------------------------
>
> Comment(by jkeenan):
>
>  Replying to [ticket:1022 coke]:
>  > PGE::Glob should have POD docs explaining the specific matching language
>  that is used. See Tcl::Glob for an example.
>  >
>  > This will help clarify that there are two different syntaxes available.
>
>  Coke, I found very few differences between the PODs of these two files.
>  The Tcl::Glob file has this section:
>  {{{
>     The following special characters are supported
>
>     "?" Matches any single character
>
>     "*" Matches any number of any characters, including no characters.
>
>     "[chars]"
>         Matches any character in the given set. Sets are either a sequence
>         of explicit characters, or a range specified with a dash, e.g.
>         [aeiou] matches lower case ASCII vowels, while [a-z] matches any
>         lowercase ASCII letter.
>
>     "\x"
>         Match a literal character, e.g. \* matches the literal "*",
>  avoiding
>         its special meaning.
>  }}}
>  ... which has no counterpart in the PGE::Glob file.  But otherwise,
>  PGE::Glob looks well documented.
>
>  Can you explain a bit more about what you think is missing?
>
>  Thank you very much.
>
>  kid51
>

That missing bit you describe is exactly the bit I mention in the
missing ticket. The actual user-level syntax of the glob language used
is never described in the docs.

-- 
Will "Coke" Coleda

Note: See TracTickets for help on using tickets.