doc: improve clarity in reduce-traffic.md and REST-interface.md #35435

pull fernandguil wants to merge 1 commits into bitcoin:master from fernandguil:doc/clarity-fixes-traffic-rest changing 2 files +3 −3
  1. fernandguil commented at 5:27 PM on June 1, 2026: contributor

    Two small clarity improvements in documentation:

    reduce-traffic.md

    • Replace "Be reminded of the effects of this setting." with "Note the following effects of this setting:" — the original phrasing is awkward and reads as if the user has already been told something they haven't.

    REST-interface.md

    • Add migration guidance to both deprecated endpoint notices (/rest/headers and /rest/blockfilterheaders) so users know to switch to the query parameter form documented directly above each one.
  2. doc: improve clarity in reduce-traffic.md and REST-interface.md
    - reduce-traffic.md: replace awkward "Be reminded of the effects"
      with clearer "Note the following effects of this setting:"
    - REST-interface.md: add migration guidance to both deprecated
      endpoint notices so users know to use the query parameter form
    6957a729a1
  3. DrahtBot added the label Docs on Jun 1, 2026
  4. DrahtBot commented at 5:27 PM on June 1, 2026: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

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

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage & Benchmarks

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

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline for information on the review process. A summary of reviews will appear here.

    <!--5faf32d7da4f0f540f40219e4f7537a3-->

  5. sedited commented at 7:15 PM on June 1, 2026: contributor

    I don't think these tiny clarity changes are worthwhile. This seems fine to me as is.

  6. sedited closed this on Jun 1, 2026

Labels

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: 2026-06-02 01:50 UTC

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