From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wm1-f68.google.com (mail-wm1-f68.google.com [209.85.128.68]) by fantadrom.bsd.lv (OpenSMTPD) with ESMTP id b2d43f81 for ; Sun, 4 Nov 2018 15:00:41 -0500 (EST) Received: by mail-wm1-f68.google.com with SMTP id 124-v6so1341252wmw.0 for ; Sun, 04 Nov 2018 12:00:40 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=tus0ozEWb1MZ/1Fjk/JOR3EGnxs8kUuqsEgAfmI3NCY=; b=DqbYdTNoiFjJ2dAY8nJMh/scf38bVTdWSc604K/SXqkRxbOoWULEiJBNEmCuOyGnRK jjfWgdoCZBR0szgIuFHB8qDIfEPBYo/yKbZQiQ3goLpNgJi1a+/u9pTQwq9p3I6olzXL vvaaZUzC1lXJ4dqEQZF8i0MeakraBZLEmvanrCuKZ3QTdDQSxBhzZBgKDgh74yj+7FVC ddA2tHth0hTsLCzrgt2gHtiG2TjVzXpw94YS/1VzgcQZFG+mdIBZouOx83VI9YkJceK+ m74xe2x/9XN8X3RvIuj3/AiwKonSOT40pGDeUTIG3WxKO92I1kahGylz/Mxnbws0k/BF aSGQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=tus0ozEWb1MZ/1Fjk/JOR3EGnxs8kUuqsEgAfmI3NCY=; b=E0msvBHPxRSuDL+A50M9GScdaVH4dYD48cDA/kbfCCKTpHbv++pzCUHjd+7cPxJ+za 7vp9IwGBPhFw6o7IV7hdVGUEBrZGitNF+eEogistz8MwHtB+C4OqT7TjYZoNfIQLJn6d j0IGh+AdVGRNewY4+JWk/hzq8pQOV3SvjBiMZ+Or0NeB/Vk7o1LL+2RVzE/T6GzkATdO xt7fWOh9Ktfvsr6PTIaMvRe4ykMMO6z+uDiOdzHqVPSukTvu0UxBIUXNiQIYCEERj1Vo jWo/7/hCw25lTZgw9iGvnVEsBnUP3qmunmXXXr4Kzo1mpzFUFaf1SL86IGq6b7W6wQum 3q3w== X-Gm-Message-State: AGRZ1gIwpap4QtuT5HXdZdeIg1GCki6actb8TX/NJqqluQKztMKtT5oW 9CRzGmuw8RqfgWcmW2iLQ08= X-Google-Smtp-Source: AJdET5eWuqqv4oyEAvu4eGCyTGYc83gl4nXPcOLeVrNHFLbq1gNsHwVKpDS0lGie/oNzbuoMChKNXA== X-Received: by 2002:a1c:124d:: with SMTP id 74-v6mr4187793wms.35.1541361637202; Sun, 04 Nov 2018 12:00:37 -0800 (PST) Received: from pali ([2a02:2b88:2:1::5cc6:2f]) by smtp.gmail.com with ESMTPSA id t77-v6sm58394689wme.18.2018.11.04.12.00.35 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sun, 04 Nov 2018 12:00:35 -0800 (PST) Date: Sun, 4 Nov 2018 21:00:34 +0100 From: Pali =?utf-8?B?Um9ow6Fy?= To: Ingo Schwarze Cc: discuss@mandoc.bsd.lv Subject: Re: mandoc & perl documentation Message-ID: <20181104200034.jum2ztzy7wvjhk6g@pali> References: <20180913151226.oaon3nvlvgcqioau@pali> <20181011075247.2jo4of7bkpvhkekm@pali> <20181023174545.GD58247@athene.usta.de> <20181024080322.hc6ifwgydpccjif3@pali> <20181025015133.GD20422@athene.usta.de> X-Mailinglist: mandoc-discuss Reply-To: discuss@mandoc.bsd.lv MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="a6dkqbsrkd72wpbc" Content-Disposition: inline In-Reply-To: <20181025015133.GD20422@athene.usta.de> User-Agent: NeoMutt/20170113 (1.7.2) --a6dkqbsrkd72wpbc Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thursday 25 October 2018 03:51:33 Ingo Schwarze wrote: > Pali Rohar wrote on Wed, Oct 24, 2018 at 10:03:22AM +0200: > > If you look at the output for Email::Address::XS, then whole > > SYNOPSIS should be written in typewriter/monospaced font. >=20 > On the one hand, no, a SYNOPSIS should absolutely not be written > in typewriter/monospaced font Hi! Now I found perlpodstyle documentation which says about SYNOPSIS: https://perldoc.perl.org/perlpodstyle.html#SYNOPSIS "For Perl module documentation, it's usually convenient to have the contents of this section be a verbatim block showing some (brief) examples of typical ways the module is used." And verbatim block is formatted by typewriter font style. perlpodstyle documentation is "general guideline for how to write POD documentation for Perl scripts and modules". --=20 Pali Roh=C3=A1r pali.rohar@gmail.com --a6dkqbsrkd72wpbc Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iF0EABECAB0WIQS4VrIQdKium2krgIWL8Mk9A+RDUgUCW99P4QAKCRCL8Mk9A+RD Uq4cAKCkCJfYkjHMoX29M3sdeFt7JxWi6ACgk8RayKc54znAyNdtYu4ksogV5/4= =MC+K -----END PGP SIGNATURE----- --a6dkqbsrkd72wpbc-- -- To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv