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

docs: be even more specific that owner is ALWAYS required #2112

Merged
merged 1 commit into from
Jun 28, 2021

Conversation

dgw
Copy link
Member

@dgw dgw commented Jun 20, 2021

Description

Noticed that while the docstring for core_section.CoreSection.owner specifies that it's always required, the "Owners & Admins" docs chapter didn't say anything about it, which could lead users to be confused.

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)
    • Doesn't touch any .py files, so I didn't run those.
  • I have tested the functionality of the things this change touches
    • N/A, like the above

Notes

Don't know yet if we'll need a 7.1.2 release, but I'm sure it'll happen. This is the first PR for it, apparently.

@dgw dgw added this to the 7.1.2 milestone Jun 20, 2021
@dgw dgw requested a review from a team June 20, 2021 05:04
@Exirel
Copy link
Contributor

Exirel commented Jun 20, 2021

Hm. I really don't like that. I mean, for 7.1.2 I'm fine, it's fixing a problem where we can fix it without breaking change.

However, I don't like forcing owner to set a config value that is ignored, it feels a bit weird. I'll see if I can think of something for Sopel 8.

docs/source/configuration.rst Outdated Show resolved Hide resolved
docs/source/configuration.rst Outdated Show resolved Hide resolved
@dgw
Copy link
Member Author

dgw commented Jun 21, 2021

I don't like forcing owner to set a config value that is ignored, it feels a bit weird.

Hard agree. I'm sure you already know this was never intended to be the final word, just a clarification for our stable branch.

To that end, you might like what I did with the .. important:: block. Push incoming; rendered preview below.

image

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.

Squash away!

@dgw dgw merged commit 0b8a942 into master Jun 28, 2021
@dgw dgw deleted the docs-owner-never-empty branch June 28, 2021 05:05
dgw added a commit that referenced this pull request Jun 28, 2021
Backports pull request #2112 to 7.1.x maintenance branch; corresponds to
merge commit on master: 0b8a942
@dgw dgw restored the docs-owner-never-empty branch June 28, 2021 05:39
@dgw dgw deleted the docs-owner-never-empty branch June 28, 2021 05:40
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