In the first case, I'd assume option #1. I know it's possible to code:

sub foo {
    my $scalar = shift;
    my ( $arrayref, $hashref );
    if ( UNIVERSAL::isa( $_[0], 'ARRAY' ) {
        $arrayref = shift;
    }    if ( UNIVERSAL::isa( $_[0], 'HASH' ) {
        $hashref = shift;
    }
    ....
}

[download]

Of course, just because it _can_ be coded that way, doesn't mean it actually is. In your second question, I'd agree with the assumption that pashing a hashref requires also passing a second argument.

...

I'm guessing you're intentionally being vague, so that we can see the issues with documentation, but sometimes there is some other context in the documentation ... if you know that there's no reason to pass both an arrayref and a hashref, you could specify:

$ret = foo($scalar, [$arrayref | $hashref] );

...

But in this case, I'm more interested in knowing if you're asking this question because you're trying to understand some documentation (in which case, what documentation, if it's publicly available?), or if you're asking for advice in writing documentation.

In reply to Re: Docs notation by jhourcle
in thread Docs notation by syphilis

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.