Skip to content

fix: 📝 Add missing docs to .respond methods#3061

Merged
Paillat-dev merged 19 commits intoPycord-Development:masterfrom
ToothyDev:fix/document_respond_parameters
Jan 25, 2026
Merged

fix: 📝 Add missing docs to .respond methods#3061
Paillat-dev merged 19 commits intoPycord-Development:masterfrom
ToothyDev:fix/document_respond_parameters

Conversation

@ToothyDev
Copy link
Contributor

Summary

Previously, the possible parameters for both Interaction.respond and ApplicationContext.respond (which copied its docs) weren't documented, this is now the case

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.

@pycord-app
Copy link

pycord-app bot commented Jan 9, 2026

Thanks for opening this pull request!
Please make sure you have read the Contributing Guidelines and Code of Conduct.

This pull request can be checked-out with:

git fetch origin pull/3061/head:pr-3061
git checkout pr-3061

This pull request can be installed with:

pip install git+https://github.com/Pycord-Development/pycord@refs/pull/3061/head

@ToothyDev ToothyDev changed the title fix:📝 Add missing docs to .respond methods fix: 📝 Add missing docs to .respond methods Jan 9, 2026
@ToothyDev ToothyDev changed the title fix: 📝 Add missing docs to .respond methods fix: 📝 Add missing docs to .respond methods Jan 9, 2026
@ToothyDev
Copy link
Contributor Author

In case I forgot any, please tell me

@ToothyDev
Copy link
Contributor Author

DA344 said I could also flesh out the method signatures of both methods to actually list and typehint the possible (kw)args for both functions, so, if you want that, just say so.

@Dorukyum
Copy link
Member

I think it'd be better if the arguments were explicitly type hinted.

@Lulalaby
Copy link
Member

I agree with doru

@ToothyDev
Copy link
Contributor Author

ToothyDev commented Jan 10, 2026

This removes the @property decorator from ApplicationContext.respond and makes the function async instead, because otherwise I can't properly overload it. In my testing, this was in no way breaking, and I already brought up in Discord how that decorator seems unnecessary for that method, but let me know what you think

@Paillat-dev Paillat-dev added documentation Improvements or additions to documentation priority: low Low Priority labels Jan 10, 2026
@Paillat-dev Paillat-dev added this to the v2.7.1 milestone Jan 10, 2026
@Paillat-dev Paillat-dev added the typing Is related to / changes python typing label Jan 10, 2026
@Paillat-dev Paillat-dev marked this pull request as draft January 10, 2026 14:08
@ToothyDev
Copy link
Contributor Author

I'd prefer this to be in 2.7.1 instead of 2.8 as in it's current form, it only really consists of adding missing documentation, even though that had to involve a minor code change (which doesn't cause any user code to break)

@ToothyDev ToothyDev requested a review from Dorukyum January 14, 2026 20:08
@Dorukyum Dorukyum enabled auto-merge (squash) January 20, 2026 13:43
Copy link
Member

@Paillat-dev Paillat-dev left a comment

Choose a reason for hiding this comment

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

code lgtm; test; thanks typing is nice :)

@Paillat-dev Paillat-dev merged commit 58f4b3e into Pycord-Development:master Jan 25, 2026
24 of 25 checks passed
@ToothyDev ToothyDev deleted the fix/document_respond_parameters branch January 25, 2026 19:13
solaluset pushed a commit to solaluset/pycord that referenced this pull request Jan 29, 2026
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Paillat <paillat@pycord.dev>
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 priority: low Low Priority typing Is related to / changes python typing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants