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

trigger: document that args is a list #2096

Merged
merged 1 commit into from
Jun 15, 2021

Conversation

half-duplex
Copy link
Member

Description

As far as I can see, trigger.py only ever has args=thing.split(), so will only ever be a list. Either the docs should reflect that, or we should tuple() those.

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

@half-duplex half-duplex added Documentation Bugfix Generally, PRs that reference (and fix) one or more issue(s) labels Jun 8, 2021
@dgw dgw added this to the 7.1.1 milestone Jun 9, 2021
Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

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

Let's not tuple() them and possibly break stuff. Fixing the documentation is plenty, cheers!

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.

Nitpick about type annotation convention in docstring.

sopel/trigger.py Outdated Show resolved Hide resolved
@dgw dgw merged commit 07c46f3 into sopel-irc:master Jun 15, 2021
dgw pushed a commit that referenced this pull request Jun 15, 2021
Backport of pull request #2096 for 7.1.1. Corresponds to merge commit
07c46f3 on master.
@half-duplex half-duplex deleted the trigger-args-list branch June 15, 2021 19:16
@half-duplex half-duplex restored the trigger-args-list branch May 14, 2023 02:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bugfix Generally, PRs that reference (and fix) one or more issue(s) Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants