I think an examples section is a good idea, but I wouldn't want a full working example in the synopsis. The data structures it's working on tend to be large on the page, and I want to keep the synopsis short. For example, here's the shortest of the functional test cases I have so far: 

    {
        name      => 'two keys',
        group_by  => ['key1', 'key2'],
        group_how => {
            count => 'count',
        },
        input => [
            {
                key1  => 'a',
                key2  => 'a',
            },
            {
                key1  => 'a',
                key2  => 'a',
            },
            {
                key1  => 'a',
                key2  => 'a',
            },
            {
                key1  => 'a',
                key2  => 'b',
            },
            {
                key1  => 'a',
                key2  => 'b',
            },
        ],
        expected => [
            {
                key1  => 'a',
                key2  => 'a',
                count => 3,
            },
            {
                key1  => 'a',
                key2  => 'b',
                count => 2,
            },
        ],
    },

[download]

In reply to Re^2: RFC: Array::GroupBy (Synopsis) by kyle
in thread RFC: Array::GroupBy by kyle

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.