Skip to content

[wip] error handling guide #7749

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 21 commits into
base: docs/guide
Choose a base branch
from
Draft

[wip] error handling guide #7749

wants to merge 21 commits into from

Conversation

LeoCx1000
Copy link
Contributor

Summary

Start work on an error handling guide.

Checklist

  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • 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, ...)

@Rapptz Rapptz added the guide This relates to the discord.py guide label Mar 22, 2022
pikaninja
pikaninja reviewed Mar 23, 2022
View reviewed changes
Copy link
Contributor

@pikaninja pikaninja left a comment

Choose a reason for hiding this comment

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

Generally good, just a few small things i found

Chrovo
Chrovo reviewed Mar 23, 2022
View reviewed changes
Chrovo
Chrovo reviewed Mar 23, 2022
View reviewed changes
Vexs
Vexs suggested changes Mar 23, 2022
View reviewed changes
Copy link
Contributor

@Vexs Vexs left a comment

Choose a reason for hiding this comment

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

It's a fine start. I'd like to see if someone could come up with a better way to handle this besides the generic if-isinstance chain.

LeoCx1000 and others added 5 commits March 25, 2022 15:49
@LeoCx1000 @pikaninja
Update docs/guide/topics/error_handling.rst
bdf0e7d 
Co-authored-by: pikaninja <38714028+pikaninja@users.noreply.github.com>
@LeoCx1000 @Chrovo
Update docs/guide/topics/error_handling.rst
8b9838a 
Co-authored-by: Chrovo <83519535+Chrovo@users.noreply.github.com>
@LeoCx1000 @Chrovo
Update docs/guide/topics/error_handling.rst
01d4a21 
Co-authored-by: Chrovo <83519535+Chrovo@users.noreply.github.com>
@LeoCx1000
wording and lines tihngy
ce776db
@LeoCx1000
Going over reviews.
a67e18a
AbstractUmbra
AbstractUmbra reviewed Apr 9, 2022
View reviewed changes
Copy link
Contributor

@AbstractUmbra AbstractUmbra left a comment

Choose a reason for hiding this comment

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

I added some comments of my views, the only section I'm not too sure about is the Views and UI Kit error handling, personally.

One comment: since we are a typed library, I feel our examples should be typed up too.

Chrovo
Chrovo reviewed Apr 9, 2022
View reviewed changes
Chrovo
Chrovo reviewed Apr 11, 2022
View reviewed changes
Chrovo
Chrovo reviewed Apr 11, 2022
View reviewed changes
Chrovo
Chrovo reviewed Apr 11, 2022
View reviewed changes
Chrovo
Chrovo reviewed Apr 11, 2022
View reviewed changes
LeoCx1000 and others added 11 commits May 4, 2022 09:57
@LeoCx1000
use hasattr insread of getattr
8eac0b1
@LeoCx1000 @AbstractUmbra
Update docs/guide/topics/error_handling.rst
223e833 
Co-authored-by: Alex Nørgaard <Umbra@AbstractUmbra.dev>
@LeoCx1000 @AbstractUmbra
Update docs/guide/topics/error_handling.rst
4a5ff56 
Co-authored-by: Alex Nørgaard <Umbra@AbstractUmbra.dev>
@LeoCx1000 @Chrovo
Update docs/guide/topics/error_handling.rst
495441e 
Co-authored-by: Chrovo <83519535+Chrovo@users.noreply.github.com>
@LeoCx1000 @Chrovo
Update docs/guide/topics/error_handling.rst
8bce28f 
Co-authored-by: Chrovo <83519535+Chrovo@users.noreply.github.com>
@LeoCx1000 @Chrovo
Update docs/guide/topics/error_handling.rst
31b2af7 
Co-authored-by: Chrovo <83519535+Chrovo@users.noreply.github.com>
@LeoCx1000 @AbstractUmbra
Update docs/guide/topics/error_handling.rst
b1edeb9 
Co-authored-by: Alex Nørgaard <Umbra@AbstractUmbra.dev>
@LeoCx1000 @AbstractUmbra
Update docs/guide/topics/error_handling.rst
2ea84ac 
Co-authored-by: Alex Nørgaard <Umbra@AbstractUmbra.dev>
@LeoCx1000 @AbstractUmbra
Update docs/guide/topics/error_handling.rst
5b37d99 
Co-authored-by: Alex Nørgaard <Umbra@AbstractUmbra.dev>
@LeoCx1000 @AbstractUmbra
Update docs/guide/topics/error_handling.rst
e6e862c 
Co-authored-by: Alex Nørgaard <Umbra@AbstractUmbra.dev>
@LeoCx1000
Move things aronund, and add type hints to examples.
f7b8fa0
GoogolGenius
GoogolGenius suggested changes Jun 7, 2022
View reviewed changes
Copy link
Contributor

@GoogolGenius GoogolGenius left a comment

Choose a reason for hiding this comment

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

Might have missed some things, but here's what I've caught so far.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AbstractUmbra AbstractUmbra AbstractUmbra left review comments

@pikaninja pikaninja pikaninja left review comments

@Druzai Druzai Druzai left review comments

@Chrovo Chrovo Chrovo left review comments

@Vexs Vexs Vexs requested changes

@GoogolGenius GoogolGenius GoogolGenius requested changes

Assignees
No one assigned
Labels
guide This relates to the discord.py guide
Projects
discord.py Documentation Guide
Status: In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@LeoCx1000 @Vexs @AbstractUmbra @JustOssa @pikaninja @Druzai @GoogolGenius @Chrovo @Rapptz @redgoldlace