Menu

#105 manpage: would like more informative document comments

Default
closed-fixed
5
7 days ago
2024-03-27
No

man documents generated by rst2man have some indication that they were automatically generated but I would prefer to see more information along these lines.

Here's the status quo.

.\" Man page generated from reStructuredText.
.\" body of man page follows
.\" Generated by docutils manpage writer.
.

In my opinion, the comments should be coalesced at the top of the document and include tool versioning information.

More like this:

.\" Man page generated from reStructuredText by rst2man
.\" from docutils 0.21rc1.

Discussion

  • engelbert gruber

    ... maybe
    docutils was command line tools : rst2something
    but is also used as a library ... so it might not be rst2man, maybe a sphinx pipeline
    but how do i know this
    but you are correct , this would be interesting

     
  • engelbert gruber

    • labels: --> manpage writer
    • assigned_to: engelbert gruber
     
  • Günter Milde

    Günter Milde - 2024-04-07

    Ticket moved from /p/docutils/bugs/480/

     
  • engelbert gruber

    • status: open --> open-fixed
    • Group: --> Default
     
  • Günter Milde

    Günter Milde - 7 days ago
    • status: open-fixed --> closed-fixed
     
  • Günter Milde

    Günter Milde - 7 days ago

    The issue is fixed in Docutils 0.22 released 2025-07-29.
    Thank you for reporting.

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.