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: Add parameter info to disnake.ext.commands.Bot.run() docstring #1240

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

nerd-bear
Copy link

@nerd-bear nerd-bear commented Oct 28, 2024

Summary

The class method run() for the class disnake.ext.commands.Bot did not have any information on what parameters it has. This is a quite small change but quite important as nearly all disnake bots use this method to start the bot. If people don't read the docs or simply just are new, they might not know what to pass.

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, ...)

@Victorsitou Victorsitou added t: documentation Improvements or additions to documentation/examples s: needs review Issue/PR is awaiting reviews skip news labels Oct 28, 2024
Signed-off-by: Nerd Bear <[email protected]>
disnake/client.py Outdated Show resolved Hide resolved
disnake/client.py Outdated Show resolved Hide resolved
Co-authored-by: shiftinv <[email protected]>
Signed-off-by: Nerd Bear <[email protected]>
@nerd-bear
Copy link
Author

I commit the first change request and added a manual commit however it seems it still shows the change request pending. @shiftinv

@nerd-bear
Copy link
Author

As well that the after only signing off on the changes that you requested, the required Lint & Test / check (pull_request) test is failing. please advise

@Snipy7374
Copy link
Contributor

I commit the first change request and added a manual commit however it seems it still shows the change request pending. @shiftinv

That's normal, it'll go away in the next round of reviews.

As well that the after only signing off on the changes that you requested, the required Lint & Test / check (pull_request) test is failing. please advise

That's because you most likely didn't follow the Contributing.md guide

I suggest to read and follow what's stated in that guide. Regardless of that you can follow these steps:

  • Install pre-commit with your preferred packet manager (e.g pip, poetry, uv, etc...)
  • Run this command pre-commit install

After following these steps run this other command:

pre-commit run

The next time you'll commit your changes the formatting will happen automatically. After you having ran the command you can push the changes, they are formatting changes.

@nerd-bear
Copy link
Author

nerd-bear commented Nov 14, 2024

It seems that all required checks are now passing and some non-required checks/tests are too except the required one, I ran pre_commit many times and check that its working but with no luck :( @shiftinv Btw may I ask when the next round of reviews are?
image
and it seems that the one required check is failing cause of a wrong pip version or am I stupid?

@nerd-bear nerd-bear changed the title Added parameter info to disnake.ext.commands.Bot.run() Add parameter info to disnake.ext.commands.Bot.run() docstring Nov 14, 2024
@nerd-bear nerd-bear changed the title Add parameter info to disnake.ext.commands.Bot.run() docstring docs: Add parameter info to disnake.ext.commands.Bot.run() docstring Nov 14, 2024
@Snipy7374
Copy link
Contributor

Snipy7374 commented Nov 14, 2024

It seems that all required checks are now passing and some non-required checks/tests are too except the required one, I ran pre_commit many times and check that its working but with no luck :( @shiftinv Btw may I ask when the next round of reviews are? image and it seems that the one required check is failing cause of a wrong pip version or am I stupid?

You still didn't format your local code. Run the pre-commit run --all-files command as said, then commit the changes and push.

The next reviews will be whenewer the reviewers have time to review the PR.

@nerd-bear
Copy link
Author

@shiftinv sorry for bothering so much, just wanted to let you know that all required and not required tests are passing. I fixed the PR title amongst some other things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
s: needs review Issue/PR is awaiting reviews skip news t: documentation Improvements or additions to documentation/examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants