Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Path setting and doc tweaks; meetbot enforcement change #1959

Merged
merged 4 commits into from
Dec 1, 2020

Conversation

dgw
Copy link
Member

@dgw dgw commented Oct 6, 2020

Description

Inspired by that raw-logs-not-working problem someone brought to our IRC the other day, which turned out to be due to quotes in the config file, I decided to make some documentation adjustments.

I might have also tried to earn a few bonus points by making meetbot enforce its own documented restriction on the meeting log path, which it said should be absolute but which it then allowed to be relative anyway.

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make quality and make test)
  • I have tested the functionality of the things this change touches

dgw added 4 commits September 29, 2020 13:42
Copied note about relative path behavior from `pid_dir` to both `logdir`
and `ca_certs` docstrings.

Added missing default-value annotations to `logdir` and `log_raw`, too,
since I was already in the neighborhood.
In particular, added an example of `logdir` and `log_raw` usage, since
I noticed those were missing when someone came to our IRC asking for
help with raw logs not working (which turned out to be due to quotes).
@dgw dgw added this to the 7.1.0 milestone Oct 6, 2020
@dgw dgw requested a review from a team October 6, 2020 21:11
Copy link
Contributor

@Exirel Exirel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment, to get your opinion on something. Otherwise: great job.

sopel/modules/meetbot.py Show resolved Hide resolved
@dgw
Copy link
Member Author

dgw commented Oct 10, 2020

Assuming @Exirel doesn't counter-argue my reasoning, I'll consider this a self-reminder to retitle the PR so it grabs my eye during changelog prep and I can add a courtesy notice about the meetbot setting behavior change.

@dgw dgw changed the title Path setting and doc tweaks Path setting and doc tweaks; meetbot enforcement change Oct 11, 2020
@dgw dgw merged commit 222d806 into master Dec 1, 2020
@dgw dgw deleted the path-setting-and-doc-tweaks branch December 1, 2020 06:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants