feat: update /interaction/select-menu #54

dlchamp · 2023-01-02T15:30:57Z

Description

Updates the page at /interactions/select-menu with relevant code examples and information about using the various select menus within disnake.

Relevant Issues

Closes #53

- Correct a couple spelling mistakes - added a bit more detail to some of the comments and wording to better get the points across and provide more detail - also removed an errant `command_sync_flags` I was using during testing the code examples

- Using the tabs feature, added a second StringSelect example that uses the @disnake.ui.string_select decorator inside a view rather than subclassing

shiftinv

Looks great, thanks for adding this!
Got a couple (mostly tiny) nits and adjustments; sorry for the amount of comments c:

guide/docs/interactions/select-menus.mdx

package-lock.json

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

This is cleaner Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Ah. The extra */} must have been added from running the pre-commit. I didn't even notice Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Altered example to disable each of the view's components by looping over them rather than using indexing

dlchamp · 2023-01-14T22:56:21Z

I'm not even sure if I'm doing this correctly. Thanks for bearing with me as I'm learning git/github. Mostly only ever deal with my own repos so I haven't been too worried about how certain things work here.

shiftinv

I'm not even sure if I'm doing this correctly. Thanks for bearing with me as I'm learning git/github. Mostly only ever deal with my own repos so I haven't been too worried about how certain things work here.

No worries, it's all good c:
For what it's worth, you can batch commit suggestions on GitHub which reduces noise a bit, but it's not strictly required as the commits all get squashed into one when merging the PR anyway.

guide/docs/interactions/select-menus.mdx

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

- Moved options into decorator and added comments to provide information describing how to define dynamic options when using the `string_select` decorator - Added Note to provide detailed info on using a list or dict as other available methods to define `SelectOptions`

abhigyantrips · 2023-03-24T08:34:02Z

@dlchamp please run pre-commit on all files once again, and commit any relevant changes.

This reverts commit cdf0b6d.

Reverted last commit to remove the built documentation files. Sorry. Pre-commit ran and this only includes the changes made to `select-menus.mdx`

abhigyantrips

This is a major addition to the guide, so thank you for the contribution!

The images in the guide so far have been extremely opinionated (having default role colors, using a "Disnake Bot" account, etc.) and might be changed in the future. But I approve of the example and implementation.

package-lock.json

shiftinv

Other than the one remaining comment, lgtm! Thank you for taking the time to add all of this.

Updated image to keep with current examples using "Disnake Bot", default role color, and Disnake logo as the bot icon

dlchamp · 2023-07-08T23:08:13Z

This is a major addition to the guide, so thank you for the contribution!

The images in the guide so far have been extremely opinionated (having default role colors, using a "Disnake Bot" account, etc.) and might be changed in the future. But I approve of the example and implementation.

Updated the image to fall inline with other examples using "Disnake Bot" with the Disnake logo and default role colors.

abhigyantrips

LGTM! Thank you so much for the contribution. We'll start working on the merge.

abhigyantrips · 2023-08-07T14:37:13Z

@dlchamp do you want to withdraw this contribution? The changes had been reviewed and approved for merge already.

dlchamp · 2023-08-07T14:41:48Z

@dlchamp do you want to withdraw this contribution? The changes had been reviewed and approved for merge already.

No. I was looking at adding to some other parts of the guide and deleted the branch local without realizing it would delete the branch here as well. My mistake. Restored.

dlchamp added 3 commits January 2, 2023 09:16

feat: update /interaction/select-menu

b5b6a11

feat: add second example using decorators

660c78c

- Using the tabs feature, added a second StringSelect example that uses the @disnake.ui.string_select decorator inside a view rather than subclassing

shiftinv added t: page/section addition Pull Request to add new content to the guide. s: needs review labels Jan 5, 2023

shiftinv requested changes Jan 5, 2023

View reviewed changes

dlchamp and others added 10 commits January 5, 2023 17:07

Update guide/docs/interactions/select-menus.mdx

6b9b107

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

c4b354b

This is cleaner Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

07931cc

Ah. The extra */} must have been added from running the pre-commit. I didn't even notice Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

62fb1e0

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

b4579e1

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

8dabfe9

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

f8c0751

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

fb1001b

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

9d92d91

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Merge branch 'dev' into update-page/select-menu

af43216

shiftinv changed the base branch from dev to main January 8, 2023 14:55

dlchamp and others added 13 commits January 14, 2023 15:54

Update guide/docs/interactions/select-menus.mdx

5fd6178

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

856dbec

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

9a54be5

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

e713d34

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

5862772

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

4ad9bc8

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

c1f076c

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

4b4b0b0

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

36b54b0

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

7cac8cd

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

a8f1779

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

2fbdfa8

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Update guide/docs/interactions/select-menus.mdx

86287bb

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Alter disable components example

1830e3a

Altered example to disable each of the view's components by looping over them rather than using indexing

shiftinv reviewed Jan 15, 2023

View reviewed changes

guide/docs/interactions/select-menus.mdx Outdated Show resolved Hide resolved

dlchamp and others added 3 commits January 15, 2023 14:28

Update guide/docs/interactions/select-menus.mdx

6f1f494

Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com> Signed-off-by: DLCHAMP <36091350+dlchamp@users.noreply.github.com>

Spelling, capitalization, punctuation, and formatting

9e9bca4

shiftinv requested a review from abhigyantrips January 18, 2023 19:59

Merge branch 'main' into update-page/select-menu

af8e0ca

dlchamp added 3 commits March 24, 2023 05:35

re-ran pre-commit on all files.

cdf0b6d

Revert "re-ran pre-commit on all files."

542ed31

This reverts commit cdf0b6d.

proper commit after reverting previous commit

cbef02e

Reverted last commit to remove the built documentation files. Sorry. Pre-commit ran and this only includes the changes made to `select-menus.mdx`

abhigyantrips requested changes Mar 25, 2023

View reviewed changes

package-lock.json Show resolved Hide resolved

abhigyantrips requested a review from shiftinv March 25, 2023 11:11

shiftinv approved these changes Mar 25, 2023

View reviewed changes

update string-select example image

284a343

Updated image to keep with current examples using "Disnake Bot", default role color, and Disnake logo as the bot icon

abhigyantrips approved these changes Jul 9, 2023

View reviewed changes

dlchamp closed this Aug 4, 2023

dlchamp deleted the update-page/select-menu branch August 4, 2023 13:27

dlchamp restored the update-page/select-menu branch August 7, 2023 14:40

shiftinv reopened this Aug 7, 2023

Merge branch 'main' into update-page/select-menu

944ea2d

abhigyantrips merged commit e3b801b into DisnakeDev:main Aug 7, 2023

feat: update /interaction/select-menu #54

feat: update /interaction/select-menu #54

Uh oh!

Conversation

dlchamp commented Jan 2, 2023

Description

Relevant Issues

Uh oh!

shiftinv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlchamp commented Jan 14, 2023

Uh oh!

shiftinv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abhigyantrips commented Mar 24, 2023

Uh oh!

abhigyantrips left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shiftinv left a comment

Choose a reason for hiding this comment

Uh oh!

dlchamp commented Jul 8, 2023

Uh oh!

abhigyantrips left a comment

Choose a reason for hiding this comment

Uh oh!

abhigyantrips commented Aug 7, 2023

Uh oh!

dlchamp commented Aug 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants