docs: FAQ entry on logging + some minor clarification #2574
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
reviewed
Nov 29, 2023
Exirel
requested changes
Nov 29, 2023
Exirel
approved these changes
Nov 29, 2023
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!
SnoopJ
approved these changes
Nov 29, 2023
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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)