Opened 5 years ago

Closed 5 years ago

Last modified 4 years ago

#14388 closed (fixed)

Logging documentation typos

Reported by: varikin Owned by: nobody
Component: Documentation Version: 1.2
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The new logging documentation has a typo with the word ERRORR:

logger.exception(): create a ERRORR level logging message wrapping the current exception stack frame.

should be

logger.exception(): create a ERROR level logging message wrapping the current exception stack frame.

If I find the time to create a patch, I will when not at work.

Attachments (2)

14388.patch (4.8 KB) - added by ramiro 5 years ago.
Patch for the reported typos and a couple more
14388_2.patch (4.8 KB) - added by gabrielhurley 5 years ago.
Corrected "a Error" -> "an Error", otherwise same patch.

Download all attachments as: .zip

Change History (10)

comment:1 Changed 5 years ago by gremmie

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Also:

  • "A logger is configured to have log level" should probably read "A logger is configured to have a log level"
  • CRITICIAL should be CRITICAL

comment:2 Changed 5 years ago by gremmie

  • Summary changed from Logging documentation has a type to Logging documentation typos

comment:3 Changed 5 years ago by ramiro

  • Has patch set

Changed 5 years ago by ramiro

Patch for the reported typos and a couple more

Changed 5 years ago by gabrielhurley

Corrected "a Error" -> "an Error", otherwise same patch.

comment:4 Changed 5 years ago by gabrielhurley

  • milestone set to 1.3
  • Triage Stage changed from Unreviewed to Ready for checkin

Added one tiny typo cleanup, otherwise patch looks good to me. Marking RFC.

comment:5 Changed 5 years ago by russellm

  • Resolution set to fixed
  • Status changed from new to closed

(In [13982]) Fixed #14388 -- Corrected some typos in the logging docs. Thanks to varikin, gremmie, Ramiro Morales and Gabriel Hurley for the reviews.

comment:6 Changed 5 years ago by russellm

(In [13983]) Refs #14388 -- Corrected another spelling erorr.

comment:7 Changed 5 years ago by russellm

(In [13984]) Refs #14388 -- ... and corrected the naming of a formatter in the sample logging config.

comment:8 Changed 4 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

Note: See TracTickets for help on using tickets.
Back to Top