Rename Author to CurrentAuthor #3
Open
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
Modeled slightly after Converters, allow specifying Converter-like class
for context-based default parameters. e.g.
```py
class Author(CustomDefault):
async def default(self, ctx):
return ctx.author
async def my_command(ctx, user: discord.Member=Author):
...
```
Also adds a few common cases (Author, Channel, Guild) for current
author, ...
With this change CustomDefaults display nicer in help commands and in command.signature
Rename Author to CurrentAuthor and while keeping Author referenced to CurrentAuthor.
khazhyk
reviewed
Apr 18, 2021
| """Default parameter which returns the author for this context.""" | ||
|
|
||
| async def default(self, ctx, param): | ||
| return ctx.author | ||
|
|
||
| Author = CurrentAuthor |
There was a problem hiding this comment.
Since this isn't merged into the lib yet, probably best not to introduce extra aliases. Anyone depending on this code in it's pre-submitted form should be prepared for it to break (e.g., I'll update my bot in case we do want this rename)
Moved discussion about the actual rename to Rapptz#1849 (comment)
There was a problem hiding this comment.
Well, I can't actually talk in there.
khazhyk
force-pushed
the
rfc-param-default
branch
2 times, most recently
from
9677dcb
to
40c234c
Compare
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.
Summary
Rename Author to CurrentAuthor and while keeping Author referenced to CurrentAuthor.
Checklist