man pages have a useless descriptions #29552

issue BebeSparkelSparkel openend this issue on March 4, 2024
  1. 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.

     0BITCOIN-TX(1)                    User Commands                   BITCOIN-TX(1)
     1
     2NAME
     3     bitcoin-tx - manual page for bitcoin-tx v25.0.0
     4
     5SYNOPSIS
     6     bitcoin-tx [options] <hex-tx> [commands]  Update hex-encoded bitcoin
     7     transaction
     8     bitcoin-tx [options] -create [commands]   Create hex-encoded bitcoin
     9     transaction
    10
    11DESCRIPTION
    12     Bitcoin Core bitcoin-tx utility version v25.0.0
    
  2. BebeSparkelSparkel renamed this:
    bitcoin-tx man page has a useless description
    man pages have a useless descriptions
    on Mar 4, 2024
  3. araujo88 commented at 4:39 pm on March 4, 2024: contributor
    @maflcko possible good first issue?
  4. fanquake added the label Docs on Mar 5, 2024

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-10-30 00:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me