On 12/12/2016 09:49 PM, Mike Gilbert wrote:
> On Mon, Dec 12, 2016 at 9:44 PM, Mike Gilbert <flop...@gentoo.org> wrote:
>> On Mon, Dec 12, 2016 at 7:34 PM, Mike Pagano <mpag...@gentoo.org> wrote:
>>> According to PMS, @USAGE is required for functions.
>>> This patch only touches comments and no code has been modified.
>>
>> PMS says nothing on the topic of eclass documentation syntax.
>>
>> Any requirements are imposed by the eclass-manpages awk script.
> 
> Maybe you were referring to the devmanual (not PMS)?
> 
> https://devmanual.gentoo.org/eclass-writing/index.html
> 
> Personally, I don't think it makes sense to add an empty @USAGE entry
> for functions that take no arguments.
> 

You're absolutely right, Mike. It was the devmanual.

I'm not a fan of having an empty usage. As the devmanual is written
today, it is not optional.

I'll leave them in for now, and if the devmanual gets updated, I'll
remove them.

-- 
Mike Pagano
Gentoo Developer - Kernel Project
Gentoo Sources - Lead
E-Mail     : mpag...@gentoo.org
GnuPG FP   : 52CC A0B0 F631 0B17 0142 F83F 92A6 DBEC 81F2 B137
Public Key :
http://http://pgp.mit.edu/pks/lookup?search=0x92A6DBEC81F2B137&op=index


Attachment: signature.asc
Description: OpenPGP digital signature

Reply via email to