As written your first example is ambiguous, because it could be you were trying to indicate that the second and third arguments are anonymous array references.

My question would be: does anyone really use these BNF syntax diagrams? They seem to be provided at the top of unix man pages primarily for the purpose of confusing newbies.

What you really need to do is provide examples of the way you expect the code to be used, combined with a written description of each of the arguments, indicating whether they're optional and so on. Demoing the use of "undef" as a placeholder is a good idea: that idiom is not at all obvious to beginners.

(By the way, it's probably bad form to have more than three or so positional arguments. If at all possible, I would suggest redesigning to use "named options", i.e. an optional hash reference of options in the last place.)

---

---

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! —

• How do I compose an effective node title?
• How do I post a question effectively?
• Markup in the Monastery

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:
	&		&
	<		&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.