From: "Darryl L. Pierce" <mcpierce@...>
Date: 2011-12-22T00:14:33+09:00
Subject: Re: RDoc - Multiline description list...

--z+pzSjdB7cqptWpS
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, Dec 22, 2011 at 12:06:37AM +0900, Darryl L. Pierce wrote:
> I have a piece of RDoc in my code:
>=20
>     # The following are the list of supported options:
>     #
>     # [create] Indicates if the address should be created; values are
>     #  *always*, *never*, *sender* or *reciever*.
>     #
>     # [assert::] Indicates whether or not to assert any specified node pr=
operties;
>     #          values are *always*, *never*, *sender* or *receiver*.
>     #
>=20
>=20
> When I generate the RDocs for the above, the entry for the create
> command shows up correctly, except that the line starting with
> "*always*" shows up outside of the box. The same thing happens with the
> [assert::] line (it's different since I'm experimenting with how to get
> things to show up properly).
>=20
> What I want to have happen is to have the entire description show up
> together. Is it possible to split the lines up so as to be more readable
> in the source code, but then have it also properly generate HTML? And,
> if so, how?
>=20
> Thanks for the help.

Seems I should have tried one more thing before posting my question. The
solution is to use this format:

    # [create]
    #   Indicates if the address should be created; values are *always*,
    #   *never*, *sender* or *reciever*.
    #
    # [assert]
    #   Indicates whether or not to assert any specified node properties;
    #   values are *always*, *never*, *sender* or *receiver*.

With this, the line in square brackets is properly used as the heading.
The rest in properly displayed as the definition.

--=20
Darryl L. Pierce <mcpierce@gmail.com>
http://mcpierce.multiply.com/
"What do you care what people think, Mr. Feynman?"

--z+pzSjdB7cqptWpS
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)

iEYEARECAAYFAk7x99UACgkQtddqM0QFuLKecQCgtHbPELqBgkM4Zaio95f4jZmm
1RUAoLS1Nq9QG+wrG8a6B8a4WKrnnymF
=3ITp
-----END PGP SIGNATURE-----

--z+pzSjdB7cqptWpS--