Return new instance in Poll.end to avoid inconsistencies

[ilovetocode2019]

Summary

Currently, the Poll.end method updates the Poll.message attribute with the response from the API call, but still returns the current instance. This can cause Poll.message to be newer than the rest of the data stored in Poll. This also means that the the instance is being updated in-place regardless of whether it is from the state, which I can't find an intentional reason for. Both of these seem inconsistent with usual library behavior.

The following example shows this behavior:

poll = discord.Poll(question="What pet is better?", duration=datetime.timedelta(hours=1))
poll.add_answer(text="Dogs")
poll.add_answer(text="Cats")
message = await messageable.send(poll=poll)

# after waiting for a bit
stopped_poll = await poll.end()
stopped_poll.answers[0].vote_count == stopped_poll.message.poll.answers[0].vote_count # false if people voted
message is poll.message # always false

This PR changes the behavior to instead return the poll created from the API call inside Poll.end. This means that making an API call will not modify the instance used to make it, instead returning a fresh one, with more updated and consistent data.

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

[DA-344]

._message still needs to be set, plus, you can simply do self._update(message) to update the data

[ilovetocode2019]

Ah, I went with this way intentionally because I wasn’t sure if the update should even be in-place. I’ll change it to make sure everything is done to the current instance.

[DA-344]

You could change the _update behaviour to update the current poll vote count and such, though

[DA-344]

This is typed likeSelf for subclasses