doc: Add missing top-level description to pruneblockchain RPC #32333

1. 
   nervana21 commented at 4:18 am on April 24, 2025: none

   Previously, the pruneblockchain RPC help output included only the method signature and arguments, with no top-level description explaining its purpose or constraints.

   This PR adds a top-level description, improving documentation consistency and alerting users to the potential impacts of using the command.

2. 
   DrahtBot commented at 4:18 am on April 24, 2025: contributor

   The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

   Code Coverage & Benchmarks

   For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32333.

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   ACK	janb84

   If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

3. DrahtBot added the label Docs on Apr 24, 2025
4. 
   laanwj commented at 1:56 pm on April 24, 2025: member

   LGTM

    0pruneblockchain height
    1
    2Deletes block and undo data up to a specified height or timestamp.
    3Requires `-prune` to be enabled at startup; this action is irreversible.
    4
    5Arguments:
    61. height    (numeric, required) The block height to prune up to. May be set to a discrete height, or to a UNIX epoch time
    7             to prune blocks whose block time is at least 2 hours older than the provided timestamp.
    8
    9Result:
   10n    (numeric) Height of the last block pruned
   11
   12Examples:
   13> bitcoin-cli pruneblockchain 1000
   

5. doc: Add missing top-level description to pruneblockchain RPC

   Previously, the `pruneblockchain` RPC help output included only the method signature and arguments, with no top-level description explaining its purpose or constraints.
   
   This PR adds a concise top-level description, improving documentation consistency and alerting users to the potential impacts of using the command.

   fa5ed18946
6. nervana21 force-pushed on Apr 28, 2025
7. 
   janb84 commented at 10:10 am on May 1, 2025: contributor

   ACK fa5ed18

   This PR adds some additional explanatory text (top level) to the pruneblockchain RPC help output. Provides more clarity what the command does and makes it more consistent with other help outputs.

   New output :

    0 % ./bitcoin-cli --regtest pruneblockchain
    1error code: -1
    2error message:
    3pruneblockchain height
    4
    5Deletes block and undo data up to a specified height or timestamp.
    6Requires `-prune` to be enabled at startup; this action is irreversible.
    7
    8Arguments:
    91. height    (numeric, required) The block height to prune up to. May be set to a discrete height, or to a UNIX epoch time
   10             to prune blocks whose block time is at least 2 hours older than the provided timestamp.
   11
   12Result:
   13n    (numeric) Height of the last block pruned
   14
   15Examples:
   16> bitcoin-cli pruneblockchain 1000
   

Contributors
nervana21 DrahtBot laanwj janb84

Labels
Docs