Fix Typo & Type Error in LavalinkException#352
Open
Jiggly-Balls wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes a typo in the docs of
wavelink.exception.LavalinkExceptionclass, where it mentions the attributereasonto hold the reason of the exception but it's theerrorattribute that holds the reason.I've decided to only change to documentation name to match the attribute name instead of matching the attribute name to the mentioned name in the doc, to prevent any backward incompatibility.
The only thing I'm not fully sure of is the additional type annotation "fix" I made, the docs mention that the
reason(errorattr) can beNonebut theErrorResponsetyped dict & theerrorattribute in theLavalinkExceptionclass don't annotate it asNone | str. So either I'm correct about the fix or the documentation is wrong aboutreason(error) beingNone | str.Checklist
P.S. There doesn't seem to be a changelog file in this repo... unless I'm terribly blind.