Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doumentation errors in the Weasel Perl module #12

Closed
jame opened this issue Aug 16, 2017 · 3 comments
Closed

Doumentation errors in the Weasel Perl module #12

jame opened this issue Aug 16, 2017 · 3 comments

Comments

@jame
Copy link

jame commented Aug 16, 2017

While working on the Debian ITP for the Weasel Perl module, Lintian found the following documentation issues during a test build of the new package::

  1. spelling-error-in-manpage - three, two in one module and one in another.
  2. manpage-has-bad-whatis-entry - two, in two different modules
  3. manpage-has-errors-from-pod2man - found in five different modules.

The spelling errors and the bad-whatis-entry issues are easily patched. The errors-from-pod2man are pod syntax errors & may need a bit more investigation. I'll present the details of the issues using patches.

Also; while reviewing other files, I found the following issues:

  1. The VERSION noted in the README.md file is "0.01" while the actual version of the module is currently "0.11", and manyu of the included modues entries in their code or POD that have similar issues.
  2. The URLs in the dist.ini file point to "ehuelsmann" rather than "perl-weasel".
@jame
Copy link
Author

jame commented Aug 16, 2017

See attached for the correction of spelling and wording issues:
SpellingErrors.patch.txt

@jame
Copy link
Author

jame commented Aug 17, 2017

The manpage-has-bad-whatis-entry in this case are caused by the NAME sections in the POD for the Perl module being incomplete. Often one can come up with a short description that can be used in the NAME sectiojn from what is noted in the DESCRIPTION section but not in this case. The two modules in question are as follows:

  1. lib/Weasel/Element/Document.pm
  2. lib/Weasel/FindExpanders/HTMLpm

@jame
Copy link
Author

jame commented Oct 5, 2017

In order to be able to get the initial package for the Perl module, I did the following:

  1. Made a correction to the SpellingErrors.patch.txt & updated the original comment here about it.

  2. Created a patch to work around the Lintian errors regarding the bad whatis entries.
    POD_Name_Errors.patch.txt

  3. Created a patch to correct the POD Syntax errors.
    POD_Syntax_Errors.patch.txt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant