Skip to content

Add dunder methods tag#1644

Merged
Xithrius merged 9 commits into
python-discord:mainfrom
Objectivitix:main
Jun 21, 2021
Merged

Add dunder methods tag#1644
Xithrius merged 9 commits into
python-discord:mainfrom
Objectivitix:main

Conversation

@Objectivitix
Copy link
Copy Markdown
Contributor

@Objectivitix Objectivitix commented Jun 16, 2021

Relevant Issues

Closes #1598.

Description

Adds the dunder methods tag described in that issue.

Sorry for the second to fourth commits, I forgot about good commit messages lol, so here they are

  1. Add text to the tag explaining dunder methods
  2. Add an example codeblock of __init__, __str__, and __repr__
  3. Make the codeblock structured like a script instead of an interactive REPL session

@Xithrius Xithrius added a: backend Related to internal functionality and utilities (error_handler, logging, security, utils and core) a: tags Related to bot tags p: 3 - low Low Priority t: feature New feature or request labels Jun 18, 2021
@Xithrius Xithrius requested a review from jb3 June 18, 2021 00:12
Copy link
Copy Markdown
Contributor

@bast0006 bast0006 left a comment

Choose a reason for hiding this comment

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

Thanks for taking the time to write this out, it's great. A chunk of these are just suggestions that could make it better rather than required changes, if you can't fit them feel free to just say so/let another reviewer look at it.

If you're curious, here's what it looks like in a testing environment at the moment: https://cdn.discordapp.com/attachments/476196003733569547/855567737653166140/dunder-method-test-1.png

Comment thread bot/resources/tags/dunder-methods.md Outdated
Comment thread bot/resources/tags/dunder-methods.md Outdated
Comment thread bot/resources/tags/dunder-methods.md Outdated
Comment thread bot/resources/tags/dunder-methods.md Outdated
Comment thread bot/resources/tags/dunder-methods.md Outdated
Comment thread bot/resources/tags/dunder-methods.md Outdated
@Objectivitix Objectivitix requested a review from bast0006 June 20, 2021 23:00
@Xithrius
Copy link
Copy Markdown
Contributor

@Objectivitix When creating a commit message, please make sure that if a person was to look back into git history they'd be able to get a hint of what occurred in a change/addition/deletion.

For more information on how to create a great commit message, see this tutorial.

Copy link
Copy Markdown
Contributor

@bast0006 bast0006 left a comment

Choose a reason for hiding this comment

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

Looks good, just two last things

Comment thread bot/resources/tags/dunder-methods.md Outdated
Comment thread bot/resources/tags/dunder-methods.md Outdated
1. delete the NOTE part
2. reword the first sentence of the second paragraph to be more succinct
@Objectivitix
Copy link
Copy Markdown
Contributor Author

@Xithrius thanks for telling me this. From now on, I'm putting all the changes in the extended description.

@Objectivitix Objectivitix requested a review from bast0006 June 21, 2021 00:41
@Xithrius
Copy link
Copy Markdown
Contributor

@Xithrius thanks for telling me this. From now on, I'm putting all the changes in the extended description.

I think this should only occur for commits that absolutely need more of an explanation. The message should be short enough to where it's not truncated by GitHub, and give a very quick insight to the change.

@Objectivitix
Copy link
Copy Markdown
Contributor Author

@Xithrius got it

@Objectivitix
Copy link
Copy Markdown
Contributor Author

All checks passed, exapoggers

@Xithrius Xithrius merged commit e74c6bf into python-discord:main Jun 21, 2021
@Objectivitix
Copy link
Copy Markdown
Contributor Author

E X A P O G G E R S

@Objectivitix
Copy link
Copy Markdown
Contributor Author

Thanks to everyone who reviewed!!

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

Labels

a: backend Related to internal functionality and utilities (error_handler, logging, security, utils and core) a: tags Related to bot tags p: 3 - low Low Priority t: feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tag: dunder methods

4 participants