I describe the structure in plain English and then give an example. I might say something like ...
The foo() function returns an arrayref, each element of which
represents a bar that I have visited. Each bar is a hashref with
the following keys:
=head2 name, address, phone
The bar's name, address and phone number
=head2 good_beer
An optional key, which if present will be a hashref of beers,
whose keys are the beers' names and the values are the breweries
that make them.
=head2 cute_staff
An optional key, which if present will be an arrayref (one element
per cute staff member) of hashrefs, with keys 'name', 'sex',
'preferred_sex' and 'phone'.
...
For example:
[
{
name => 'The Traditional Pub,
address => '13 Wharf St, Workingclasstown',
phone => '01234 567890',
good_beer => {
'Tanglefoot' => 'Badger',
'Paradise Ale' => 'Theakstons',
'Special' => 'Youngs'
},
cute_staff => [ # array in case there's two with the
{ # same name
name => 'Jill',
sex => 'F',
preferred_sex => 'M',
phone => '01234567899'
} ...
]
},
...
]
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
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, 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, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
Outside of code tags, you may need to use entities for some characters:
| |
For: |
|
Use: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
|
|