flake8
passed.
JSHint
passed.
maubin got a fish trophy!
Replace non-named logging with named logging for reviewboard.diffviewer
Review Request #11811 — Created Sept. 17, 2021 and submitted
While reviewboard.diffviewer already uses some named logging, this commit
replaces all other usages of non-named logging with named logging instead.Switching to named logging allows the logging mechanism to automatically
include information about the module and where the logging message came
from.
Ran unit tests for reviewboard.diffviewer and passed all tests.
| Summary | ID | Author |
|---|---|---|
| 275c6085f9a108507279031e5bdec98153dab828 | Michelle | |
| b20c33b0f96792e529278d19ae9d319599285015 | Michelle |
| Description | From | Last Updated |
|---|---|---|
|
The summary, description, and testing all mention "diffview", but the name of the module is "diffviewer". |
 chipx86
|
|
|
The description should wrap to around 75 characters, in order to ensure it fits properly in a Git diff. This … |
chipx86
|
|
|
Just realized, this seems to be missing the bug number. You can fill that in on the "Bugs" field on … |
chipx86
|
|
|
For the top-level of a module, we use two blank lines between sections. The constants above are one section, and … |
chipx86
|
|
|
The attribute values on the following two lines no longer line up with the one on the first line. |
chipx86
|
|
|
Same as in the other file, you'll want two blank lines on either side of this declaration. |
chipx86
|
|
|
Same as in the other file, the parameters no longer align. This repeats for the changes made below, so make … |
chipx86
|
-
-
The summary, description, and testing all mention "diffview", but the name of the module is "diffviewer".
-
The description should wrap to around 75 characters, in order to ensure it fits properly in a Git diff. This is where it helps to make sure the description is written when making a commit, as that is often configured to impose a line length limit.
-
For the top-level of a module, we use two blank lines between sections. The constants above are one section, and this
loggercan be seen as another section (instance declarations). Functions are another section.Just like how there were two blank lines between
_PATCH_GARBAGE_INPUTanddef convert_to_unicode, you'll want to have two blank lines on either side oflogger =. -
-
-
Same as in the other file, the parameters no longer align.
This repeats for the changes made below, so make sure that those are fixed as well.
- Change Summary:
-
Fixed formatting issues in the code and review request description, added bug number
- Summary:
-
Replace non-named logging with named logging for reviewboard.diffviewReplace non-named logging with named logging for reviewboard.diffviewer
- Description:
-
~ While reviewboard.diffview already uses some named logging, this commit replaces all other usages of non-named logging with named logging instead.
~ Switching to named logging allows the logging mechanism to automatically include information about the module and where the logging message came from. ~ While reviewboard.diffviewer already uses some named logging, this commit
~ replaces all other usages of non-named logging with named logging instead. + + Switching to named logging allows the logging mechanism to automatically
+ include information about the module and where the logging message came + from. - Testing Done:
-
~ Ran unit tests for reviewboard.diffview and passed all tests.
~ Ran unit tests for reviewboard.diffviewer and passed all tests.
- Commits:
-
Summary ID Author 275c6085f9a108507279031e5bdec98153dab828 Michelle 275c6085f9a108507279031e5bdec98153dab828 Michelle b20c33b0f96792e529278d19ae9d319599285015 Michelle - Bugs:
-
- Diff:
Revision 2 (+98 -86)
Checks run (2 succeeded)
flake8 passed.JSHint passed.