Skip to content

Comments

docs: misc fixes/clarifications#1137

Merged
shiftinv merged 7 commits intomasterfrom
docs/misc-fixes
Feb 2, 2024
Merged

docs: misc fixes/clarifications#1137
shiftinv merged 7 commits intomasterfrom
docs/misc-fixes

Conversation

@shiftinv
Copy link
Member

@shiftinv shiftinv commented Dec 8, 2023

Summary

A collection of documentation fixes for things that aren't big enough to warrant their own PRs.
Going to keep this as a draft for a little while; if anyone has further nits, please leave a comment.

Checklist

  • If code changes were made, then they have been tested
    • I have updated the documentation to reflect the changes
    • I have formatted the code properly by running pdm lint
    • I have type-checked the code by running pdm pyright
  • 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, ...)

@shiftinv shiftinv added t: documentation Improvements or additions to documentation/examples skip news labels Dec 8, 2023
@shiftinv shiftinv added this to the disnake v2.10 milestone Dec 8, 2023
@EQUENOS
Copy link
Member

EQUENOS commented Dec 8, 2023

Thank you for keeping this as a draft! Here're my suggestions:

  • <...>Bot.reload_extension docs should clarify the relation with app command sync
  • Interaction.edit_original_response should clarify which message will be edited in case of different interaction types (*)

*: for example, if one defers a message interaction response and then calls edit_original_response then the message being edited is the one with the clicked component

@shiftinv
Copy link
Member Author

shiftinv commented Dec 9, 2023

Thanks for the comment! :>

  • <...>Bot.reload_extension docs should clarify the relation with app command sync

Not sure about this, could you explain it a little more? If this is about automatically syncing on cog load/unload then I suppose we should mention it in Bot.add_cog instead.
edit: 5eab532

  • Interaction.edit_original_response should clarify which message will be edited in case of different interaction types

There's a fairly basic table here, though I removed the table entirely in #1113 since it was arguably not the best.

@shiftinv shiftinv marked this pull request as ready for review January 28, 2024 11:46
Copy link
Contributor

@elenakrittik elenakrittik left a comment

Choose a reason for hiding this comment

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

If my word costs anything 😁

@shiftinv shiftinv merged commit 699ffc4 into master Feb 2, 2024
@shiftinv shiftinv deleted the docs/misc-fixes branch February 2, 2024 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip news t: documentation Improvements or additions to documentation/examples

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants