docs: FAQ entry on logging + some minor clarification #2574
Conversation
There is always a log format and a log date format because those options in the core section have defaults. Likewise, the default logging level of INFO exists even if not set explicitly by the config file. (Removed the confusing bit about WARNING being the default; that's the default of the `level` argument to `logging.basicConfig()`, but Sopel always passes the value of its `logging_level` setting.)
SnoopJ
left a comment
SnoopJ
left a comment
There was a problem hiding this comment.
You're a good sport, thank you for tackling this one!
Modulo my one remark about more cleanly separating "do this when filing a report" from more thorough information about raw logs, this LGTM.
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
Minor nitpicking, aside from that, great idea!
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
I still think this is too verbose and would be better with less compact paragraphs. However, I don't have the proper wording/phrasing in mind, and it's better to have all that information in the FAQ now than wait another month to get the "best" version.
That will do, and I'm happy about it!
It is relative to the config's `homedir`, which is the config's parent folder by default but can be changed. While I was here: Added a note indicating why one might want to change the `homedir` setting, for example to match service-unit conventions.
|
I should note that merging this should come with a follow-up PR (draft) updating the relevant issue template(s) to link to this entry from the "Relevant logs" field description. Assuming links are allowed there, that is. I haven't checked into that yet. |
Description
After I closed #2395 there was some question whether the FAQ added in #2533 actually covered everything that was requested.
Deciding that we could always do it better, @SnoopJ convinced me (it wasn't hard) to add more info about logs to the FAQ.
I also clarified a piece of the "Logging" section docs under "The [core] configuration section" because it confused me, too.
Checklist
make qa(runsmake lintandmake test)