Skip Menu |
 
rt.cpan.org will be shut down on March 1st, 2021.

This queue is for tickets about the Pod-Spell CPAN distribution.

Report information
The Basics
Id: 57492
Status: open
Priority: 0/
Queue: Pod-Spell

People
Owner: Nobody in particular
Requestors: APOCAL [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Normal
Broken in: 1.01
Fixed in: (no value)



Subject: Ordering of stopwords is important!
Download (untitled) / with headers
text/plain 890b
Hello, I've been using this module for a while and loved it for catching my typos, ha! However, I've always been puzzled that sometimes it would fail tests, telling me that "foo" is misspelled. I've added it to the stopwords list! After giving up and accepting FAILs sometimes, I somehow arrived at the solution for this. This module parses the POD and adds stopwords, and checks the validity of words at the same time. So if you have POD like this: =head1 DESCRIPTION foo is the best! =for stopwords foo It will fail the test, but if you swap the head1 and stopwords like this: =for stopwords foo =head1 DESCRIPTION foo is the best! It will PASS, yay! I think this is a situation where many authors could get tripped over. I don't think the code should be fixed to address this, but just a mention in the POD would be good enough. Thanks again! -- ~Apocalypse
is this still an issue?
Subject: Re: [rt.cpan.org #57492] Ordering of stopwords is important!
Date: Thu, 19 Sep 2013 01:06:54 -0500
To: bug-Pod-Spell [...] rt.cpan.org
From: Caleb Cushing <xenoterracide [...] gmail.com>
Download (untitled) / with headers
text/plain 505b
probably, but I'm not sure. Pod::Spell needs a lot of work, but is still not as well tested as it should be, and parts of it still seem cryptic. On Wed, Sep 18, 2013 at 10:01 PM, Karen Etheridge via RT <bug-Pod-Spell@rt.cpan.org> wrote: Show quoted text
> Queue: Pod-Spell > Ticket <URL: https://rt.cpan.org/Ticket/Display.html?id=57492 > > > is this still an issue?
-- Caleb Cushing http://xenoterracide.com Calendar: https://www.google.com/calendar/embed?src=xenoterracide%40gmail.com&ctz=America/Chicago
Download (untitled) / with headers
text/plain 431b
On Wed Sep 18 23:01:58 2013, ETHER wrote: Show quoted text
> is this still an issue?
Yes. Pod::Spell is an extended Pod::Parser. It makes a single pass over the file, spewing data to an output handle. It learns stopwords as it goes and uses them on subsequent text. "Fixing" this would probably mean moving away from Pod::Parser and the use of an output handle. I think a documentation fix is sufficient. I've pushed a commit to that effect.


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.