Simple security.doc improvement #31114

1. 
   toogoodtofail commented at 9:15 pm on October 18, 2024: none

   Improvement on readability and usability of (preview) markdown code.
2. made key import more clear and easier to work with a211abfaa9
3. easier to read cc94f40c60
4. fixed urls b01d062eb9
5. 
   DrahtBot commented at 9:15 pm on October 18, 2024: contributor

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

   Code Coverage

   For detailed information about the code coverage, see the test coverage report.

   Reviews

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

6. DrahtBot added the label Backport on Oct 18, 2024
7. Av32000 approved
8. fix markdown headers e9619ce5be
9. more clean look 39a8ba3892
10. added headers 641fb06dbf
11. realigned with setext style format 2926251e69
12. fenced code fix d550698c00
13. 
    achow101 commented at 8:32 pm on October 19, 2024: member

    Thank you for your contribution. Stylistic and formatting changes to documentation are generally discouraged as they come at a cost for the project as a whole while not meaningfully changing anything. In particular, many of the changes in this PR do not change how things are rendered, nor the readability of the documentation even when viewed in plain text. The motivation provided does not justify the burden on the project that this may place on the project. A burden could be any of the following:

    • Time spent on review
    • (Silent) merge conflicts, either in the branch or a backport branch. Those conflicts demand further developer and reviewer time or introduce incorrect information.

    For more information about refactoring changes and stylistic cleanup, see

    • https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#refactoring
    • https://github.com/bitcoin/bitcoin/blob/master/.github/PULL_REQUEST_TEMPLATE.md
    • #15465
    • #26621 (comment)

    Generally, if the style is not mentioned nor enforced by the developer notes, we leave it up to the original author to pick whatever fits them best personally and then leave it that way until the line is touched for other reasons.

    Additionally, this PR is opened against the 28.x branch which is a release branch. Changes to release branches are made via backports; all changes must first be made to the master branch.

    Let us know if you have any questions.

14. achow101 closed this on Oct 19, 2024

    ---

Contributors
toogoodtofail DrahtBot Av32000 achow101

Labels
Backport