Skip to content

Commit

Permalink
Update doc/guide/Guide_Exception_Logging.ipynb
Browse files Browse the repository at this point in the history
Co-authored-by: leonie-villiger <[email protected]>
  • Loading branch information
sarah-hlsn and leonie-villiger authored Nov 28, 2023
1 parent 8d21cd5 commit 91db8c8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/guide/Guide_Exception_Logging.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@
"- In CLIMADA, you cannot use printing. Any output must go into the LOGGER. \n",
"\n",
"\n",
"- For any logging messages, always think about the audience. What would a user or developer need for information? This also implies to carefully think about the correct LOGGER level. For instance, some information is for debugging, then use the debug level. In this case, make sure that the message actually helps the debugging process! Some message might just to inform the user about certain default parameters, then use the inform level. See below for more details about logger levels.\n",
"- For any logging messages, always think about the audience. What would a user or developer need for information? This also implies to carefully think about the correct LOGGER level. For instance, some information is for debugging, then use the debug level. In this case, make sure that the message actually helps the debugging process! Some message might just inform the user about certain default parameters, then use the inform level. See below for more details about logger levels.\n",
"\n",
"\n",
"- Do not overuse the LOGGER. Think about which level of logging. Logging errors must be useful for debugging."
Expand Down

0 comments on commit 91db8c8

Please sign in to comment.