doc: Add missing backtick in developer notes logging section #29241

1. 
   fjahr commented at 2:54 PM on January 12, 2024: contributor

   Newly added logging section from #28318 is missing a single backtick. Also fixes some minor punctuation errors in that section.

2. 
   DrahtBot commented at 2:54 PM on January 12, 2024: contributor

   <!--e57a25ab6845829454e8d69fc972939a-->

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

   <!--006a51241073e994b41acfe9ec718e94-->

   Code Coverage

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

   <!--021abf342d371248e50ceaed478a90ca-->

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   ACK	jonatack, alfonsoromanz
   Stale ACK	ismaelsadeeq

   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 Jan 12, 2024
4. 
   ismaelsadeeq commented at 2:58 PM on January 12, 2024: member

   utACK a29d5c9f5100a5e15b243960ebc505305a70901e 👍🏾

   Thanks was just reading this

5. in doc/developer-notes.md:758 in a29d5c9f51 outdated

    754 | @@ -755,7 +755,7 @@ logging messages. They should be used as follows:
    755 |    severe enough to warrant shutting down the node (eg, system time
    756 |    appears to be wrong, unknown soft fork appears to have activated).
    757 |  
    758 | -- `LogTrace(BCLog::CATEGORY, fmt, params...) should be used in place of
    759 | +- `LogTrace(BCLog::CATEGORY, fmt, params...)` should be used in place of
   

   ---

   ---

   

   jonatack commented at 3:07 PM on January 12, 2024:

   While touching these, suggest also this

   @@ -742,7 +742,7 @@ logging messages. They should be used as follows:
    - `LogInfo(fmt, params...)` should only be used rarely, eg for startup
      messages or for infrequent and important events such as a new block tip
      being found or a new outbound connection being made. These log messages
   -  are unconditional so care must be taken that they can't be used by an
   +  are unconditional, so care must be taken that they can't be used by an
      attacker to fill up storage. Note that `LogPrintf(fmt, params...)` is
      a deprecated alias for `LogInfo`.
   

   and s/eg/e.g./ throughout this section.

   ---

   

   fjahr commented at 3:27 PM on January 12, 2024:

   Done, thanks!

6. 
   jonatack commented at 3:07 PM on January 12, 2024: member

   ACK a29d5c9f5100a5e15b243960ebc505305a70901e, couple suggestions

7. doc: Add missing backtick in developer notes logging section

   Also fix some minor punctuation error in the section.

   c003562120
8. fjahr force-pushed on Jan 12, 2024
9. 
   jonatack commented at 4:10 PM on January 12, 2024: member

   ACK c003562120c193c296ac754b4bb8cff02bbbe4dc

   Tangential, I don't understand the macro ordering in this line:

   The macros `LogInfo`, `LogDebug`, `LogTrace`, `LogWarning` and `LogError` are available for
   

10. DrahtBot requested review from ismaelsadeeq on Jan 12, 2024
11. 
    alfonsoromanz commented at 6:07 PM on January 12, 2024: contributor

    ACK c003562120c193c296ac754b4bb8cff02bbbe4dc

12. fanquake merged this on Jan 15, 2024
13. fanquake closed this on Jan 15, 2024

    ---

14. bitcoin locked this on Jan 14, 2025

Contributors

fjahrDrahtBotismaelsadeeqjonatackalfonsoromanz

Review Requested
ismaelsadeeq