Bug 274086 - textproc/md2roff: correct package description
Summary: textproc/md2roff: correct package description
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Robert Clausecker
URL: https://www.freshports.org/textproc/m...
Keywords:
Depends on:
Blocks:
 
Reported: 2023-09-25 18:25 UTC by Graham Perrin
Modified: 2023-09-30 20:03 UTC (History)
0 users

See Also:
bugzilla: maintainer-feedback? (fuz)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin 2023-09-25 18:25:05 UTC
The description begins: 

> md2roff is a Markdown to roff/html converted. …

Should be, converter.
Comment 1 Robert Clausecker freebsd_committer freebsd_triage 2023-09-25 18:30:08 UTC
Thank you for catching this.  I make this -er/-ed typo quite often and I don't really know why it keeps happening.  The new pkg-descr will be:

> md2roff is a Markdown to roff/html converter.  It can be used to
> generate simple man pages from markdown-formatted project README
> files.  The program produces a manpage in man(7) format and an
> HTML document as output.
Comment 2 Graham Perrin 2023-09-25 20:06:15 UTC
(In reply to Robert Clausecker from comment #1)

It was the WWW that first caught my eye, because I wondered about usage, but that can be discussed elsewhere, and I'm not in a rush. 

Looking closely at the description, a nit: 

man pages (with a space)
manpage   (without)

man(7) uses the non-abbreviated phrase 'manual pages' so FWIW, I'd go for non-abbreviated and with a space. 

Ta
Comment 3 Graham Perrin 2023-09-25 20:07:36 UTC
Oh, and uppercase M for for the second occurrence of Markdown
Comment 4 commit-hook freebsd_committer freebsd_triage 2023-09-30 20:01:31 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=9b4bfae8c15cd8be1bf357e0c207b03cada7eb3d

commit 9b4bfae8c15cd8be1bf357e0c207b03cada7eb3d
Author:     Robert Clausecker <fuz@FreeBSD.org>
AuthorDate: 2023-09-25 18:26:59 +0000
Commit:     Robert Clausecker <fuz@FreeBSD.org>
CommitDate: 2023-09-30 20:00:00 +0000

    textproc/md2roff: fix typo in pkg-descr

    Reported by:    Graham Perrin <grahamperrin@gmail.com>
    PR:             274086

 textproc/md2roff/pkg-descr | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Comment 5 Robert Clausecker freebsd_committer freebsd_triage 2023-09-30 20:03:41 UTC
Thank you for your report.