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: fix incorrect documentation about discord.Option.autocomplete #2265

Merged
merged 7 commits into from
Feb 2, 2024
Merged

docs: fix incorrect documentation about discord.Option.autocomplete #2265

merged 7 commits into from
Feb 2, 2024

Conversation

Blue-Robin-Taken
Copy link
Contributor

Summary

This PR rephrases attr description in docs because it does not allow for string iterables.

Information

  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed).
  • This PR is not a code change (e.g. documentation, README, typehinting,
    examples, ...).

Checklist

  • I have searched the open pull requests for duplicates.
  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • If type: ignore comments were used, a comment is also left explaining why.
  • I have updated the changelog to include these changes.

@Blue-Robin-Taken
Copy link
Contributor Author

I'll add the changelog in a sec

@Blue-Robin-Taken Blue-Robin-Taken changed the title Update options.py Docs: Update options.py Nov 20, 2023
@Blue-Robin-Taken Blue-Robin-Taken changed the title Docs: Update options.py Docs: Fix discord.Option.autocomplete documentation Nov 20, 2023
@Blue-Robin-Taken
Copy link
Contributor Author

I accidentally forgot to change the title, but I fixed that now

@Lulalaby Lulalaby requested a review from plun1331 November 20, 2023 06:50
@Lulalaby Lulalaby added the documentation Improvements or additions to documentation label Nov 20, 2023
@Lulalaby Lulalaby added this to the v2.5 milestone Nov 20, 2023
@Lulalaby Lulalaby changed the title Docs: Fix discord.Option.autocomplete documentation fix(docs): Fixed inccorect documentation about discord.Option.autocomplete Nov 20, 2023
@Lulalaby Lulalaby changed the title fix(docs): Fixed inccorect documentation about discord.Option.autocomplete fix(docs): Fixed inccorect documentation about discord.Option.autocomplete Nov 20, 2023
Lulalaby
Lulalaby previously approved these changes Nov 20, 2023
@Lulalaby Lulalaby enabled auto-merge (squash) November 20, 2023 06:53
@Blue-Robin-Taken Blue-Robin-Taken changed the title fix(docs): Fixed inccorect documentation about discord.Option.autocomplete fix(docs): Fixed incorrect documentation about discord.Option.autocomplete Nov 20, 2023
@Blue-Robin-Taken
Copy link
Contributor Author

minor typo fix

discord/commands/options.py Outdated Show resolved Hide resolved
auto-merge was automatically disabled November 22, 2023 17:50

Head branch was pushed to by a user without write access

@Blue-Robin-Taken
Copy link
Contributor Author

waaait so if I change something, it dismisses reviews from before?! I guess that makes sense though

@Blue-Robin-Taken
Copy link
Contributor Author

Lol I forgot I made this PR, sorry bout that. School and stuff got me busy.

@Lulalaby
Copy link
Member

Lulalaby commented Feb 2, 2024

All good, we want to clean up stuff

@Blue-Robin-Taken
Copy link
Contributor Author

Blue-Robin-Taken commented Feb 2, 2024

Would setting [:class:Any] be fine

@Lulalaby
Copy link
Member

Lulalaby commented Feb 2, 2024

i don't think so since any is not truly valid

@Lulalaby
Copy link
Member

Lulalaby commented Feb 2, 2024

@NeloBlivion thoughts?

@Blue-Robin-Taken
Copy link
Contributor Author

I'll dive deeper into the actual code to see what the real class is in the meantime

@Blue-Robin-Taken
Copy link
Contributor Author

The docs right now currently say: Accepts an iterable of :class:str or :class:OptionChoice
Which is definitely not true from what I remember

Co-authored-by: UK <[email protected]>
Signed-off-by: Blue-Robin-Taken <[email protected]>
@Lulalaby Lulalaby dismissed plun1331’s stale review February 2, 2024 04:42

Github asks me why I dismiss. Meow meow I'm just a silly cat.

@Blue-Robin-Taken
Copy link
Contributor Author

Blue-Robin-Taken commented Feb 2, 2024

Should I also change the:
Optional[Callable[[:class:`.AutocompleteContext`], Awaitable[Union[Iterable[:class:`.OptionChoice`], Iterable[:class:`str`], Iterable[:class:`int`], Iterable[:class:`float`]]]]]

@Lulalaby
Copy link
Member

Lulalaby commented Feb 2, 2024

Hmm I'm unsure

Copy link
Member

@Lulalaby Lulalaby left a comment

Choose a reason for hiding this comment

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

looks good to me, @NeloBlivion approve if u agree :3

@Lulalaby Lulalaby enabled auto-merge (squash) February 2, 2024 05:25
@Lulalaby Lulalaby merged commit e9efa2c into Pycord-Development:master Feb 2, 2024
29 checks passed
@Blue-Robin-Taken Blue-Robin-Taken deleted the patch-2 branch February 2, 2024 05:31
@Blue-Robin-Taken
Copy link
Contributor Author

That was my first PR that merged to a repo that wasn't from a school club & is public

@Lulalaby
Copy link
Member

Lulalaby commented Feb 2, 2024

gg's xD

OmLanke pushed a commit to OmLanke/pycord that referenced this pull request Feb 9, 2024
…Pycord-Development#2265)

Signed-off-by: Blue-Robin-Taken <[email protected]>
Signed-off-by: Lala Sabathil <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: plun1331 <[email protected]>
Co-authored-by: Lala Sabathil <[email protected]>
Co-authored-by: NeloBlivion <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants