man pages have a useless descriptions #29552

issue BebeSparkelSparkel opened this issue on March 4, 2024

BebeSparkelSparkel commented at 3:51 PM on March 4, 2024: none

Generally, the short description in the NAME section and the long description in the DESCRIPTION describe the capabilities of the tool and what it is intended for. For most of the man pages they state that the tool is the tool.

BITCOIN-TX(1)                    User Commands                   BITCOIN-TX(1)

NAME
     bitcoin-tx - manual page for bitcoin-tx v25.0.0

SYNOPSIS
     bitcoin-tx [options] <hex-tx> [commands]  Update hex-encoded bitcoin
     transaction
     bitcoin-tx [options] -create [commands]   Create hex-encoded bitcoin
     transaction

DESCRIPTION
     Bitcoin Core bitcoin-tx utility version v25.0.0

BebeSparkelSparkel renamed this:
~~bitcoin-tx man page has a useless description~~
man pages have a useless descriptions
on Mar 4, 2024
leo-aa88 commented at 4:39 PM on March 4, 2024: contributor

@maflcko possible good first issue?
fanquake added the label Docs on Mar 5, 2024
achow101 closed this on Nov 8, 2024
pniwre referenced this in commit f842d0801e on Nov 8, 2024
bitcoin locked this on Nov 8, 2025

Contributors

BebeSparkelSparkel

leo-aa88

Labels

Docs

Linked (view graph)

#29686 Update manpage descriptions