Bug #83640 for Pod-Spelling: Option to ignore functions/methods

Tue Feb 26 09:43:30 2013 rrwo [...] cpan.org - Ticket created

Subject:

Option to ignore functions/methods

It would be nice to add an option so that functions/method names in the module are added to the stopwords list automatically.

Tue Feb 26 10:41:58 2013 lee [...] leegoddard.net - Correspondence added

Subject:	Re: [rt.cpan.org #83640] Option to ignore functions/methods
Date:	Tue, 26 Feb 2013 16:41:47 +0100
To:	bug-Pod-Spelling [...] rt.cpan.org
From:	Lee Goddard <leegee [...] gmail.com>

Would it be too rigid to have sub names ignored only if they were marked as C<code>? On 26/02/2013 15:43, Robert Rothenberg via RT wrote: Show quoted text

> Tue Feb 26 09:43:30 2013: Request 83640 was acted upon. > Transaction: Ticket created by RRWO > Queue: Pod-Spelling > Subject: Option to ignore functions/methods > Broken in: 0.15 > Severity: Wishlist > Owner: Nobody > Requestors: rrwo@cpan.org > Status: new > Ticket <URL: https://rt.cpan.org/Ticket/Display.html?id=83640 > > > > It would be nice to add an option so that functions/method names in the > module are added to the stopwords list automatically. >

Tue Feb 26 10:41:59 2013 The RT System itself - Status changed from 'new' to 'open'

Tue Feb 26 12:46:16 2013 lee [...] leegoddard.net - Correspondence added

Subject:	Re: [rt.cpan.org #83640] Option to ignore functions/methods
Date:	Tue, 26 Feb 2013 18:46:03 +0100
To:	bug-Pod-Spelling [...] rt.cpan.org
From:	Lee Goddard <leegee [...] gmail.com>

I don't know how to do this without loading the modules... I presume Perl has a Perl parser, though work's too heavy atm to start on that for a while. On 26/02/2013 15:43, Robert Rothenberg via RT wrote: Show quoted text

> Tue Feb 26 09:43:30 2013: Request 83640 was acted upon. > Transaction: Ticket created by RRWO > Queue: Pod-Spelling > Subject: Option to ignore functions/methods > Broken in: 0.15 > Severity: Wishlist > Owner: Nobody > Requestors: rrwo@cpan.org > Status: new > Ticket <URL: https://rt.cpan.org/Ticket/Display.html?id=83640 > > > > It would be nice to add an option so that functions/method names in the > module are added to the stopwords list automatically. >

Wed Feb 27 10:05:02 2013 rrwo [...] cpan.org - Correspondence added

CC:	rrwo [...] cpan.org
Subject:	Re: [rt.cpan.org #83640] Option to ignore functions/methods
Date:	Wed, 27 Feb 2013 15:04:48 +0000
To:	bug-Pod-Spelling [...] rt.cpan.org
From:	Robert Rothenberg <rrwo [...] cpan.org>

On 26/02/13 17:46 lee@leegoddard.net via RT wrote: Show quoted text

> <URL: https://rt.cpan.org/Ticket/Display.html?id=83640 > > > > I don't know how to do this without loading the modules... > > I presume Perl has a Perl parser, though work's too heavy atm to start > on that for a while.

You might get away with something that reads the file as text and looks for occurrences of /sub\s+(\w+)\s/ - I'm willing to bet that would capture 99% of the method names. The downside is that you'd have to read the file twice: once using the POD parser and once to get the sub names... unless there's a way to get POD::POM to feed you the non-POD bits.

Wed Feb 27 10:05:46 2013 rrwo [...] cpan.org - Correspondence added

Subject:	Re: [rt.cpan.org #83640] Option to ignore functions/methods
Date:	Wed, 27 Feb 2013 14:57:03 +0000
To:	bug-Pod-Spelling [...] rt.cpan.org
From:	Robert Rothenberg <rrwo [...] cpan.org>

On 26/02/13 15:41 lee@leegoddard.net via RT wrote: Show quoted text

> <URL: https://rt.cpan.org/Ticket/Display.html?id=83640 > > > Would it be too rigid to have sub names ignored only if they were marked > as C<code>?

Possibly. Does Test::Pod::Coverage recognize when sub names are in C<>? Can one put headings and items in code, e.g. "=head2 C<my_method>"? Show quoted text

> > On 26/02/2013 15:43, Robert Rothenberg via RT wrote:

>> Tue Feb 26 09:43:30 2013: Request 83640 was acted upon. >> Transaction: Ticket created by RRWO >> Queue: Pod-Spelling >> Subject: Option to ignore functions/methods >> Broken in: 0.15 >> Severity: Wishlist >> Owner: Nobody >> Requestors: rrwo@cpan.org >> Status: new >> Ticket <URL: https://rt.cpan.org/Ticket/Display.html?id=83640 > >> >> >> It would be nice to add an option so that functions/method names in the >> module are added to the stopwords list automatically. >>

> >