doc: deduplicate list of chain/network strings in RPC/parameter help texts #30645

issue theStack openend this issue on August 13, 2024
  1. theStack commented at 2:57 pm on August 13, 2024: contributor

    Motivation

    Many command line parameter and RPC help texts currently contain the list of chain/network names hardcoded (“main, test, testnet4, signet, regtest”), which is error-prone as it can easily happen to miss an instance if the list ever changes again.

    Possible solution

    For better maintainability, the list should be deduplicated, either with a constant string or a function creating that string like ListChainTypes. See the suggestions #30642 (review) and #30642 (review).

    Useful Skills

    • Compiling Bitcoin Core from source
    • Basic C++ skills

    Guidance for new contributors

    Want to work on this issue?

    For guidance on contributing, please read CONTRIBUTING.md before opening your pull request.

  2. theStack added the label good first issue on Aug 13, 2024
  3. martinsaposnic commented at 3:12 pm on August 13, 2024: contributor
    working on this 🙂
  4. martinsaposnic commented at 5:07 pm on August 13, 2024: contributor
    new PR with possible solution: https://github.com/bitcoin/bitcoin/pull/30648
  5. achow101 referenced this in commit 0e42c1b6c5 on Aug 14, 2024
  6. willcl-ark commented at 7:18 am on August 19, 2024: member
    Closing since #30648 was merged
  7. willcl-ark closed this on Aug 19, 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-09-28 22:12 UTC

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