Add guides to docs #1522
Draft
Add guides to docs #1522
Conversation
This file contains 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
Lunarmagpie
reviewed
Feb 25, 2023
Comment on lines
+27
to
+33
| You may also put the event's type in the decorator instead of a type annotation: | ||
|
|
||
| ```py | ||
| @bot.listen(hikari.MessageCreateEvent) | ||
| async def message_listener(event) -> None: | ||
| print(f"I have received a message from {event.author} in {event.channel_id}!") | ||
| ``` |
There was a problem hiding this comment.
Although this is possible, does the guide need to show this?
Suggested change
| You may also put the event's type in the decorator instead of a type annotation: | |
| ```py | |
| @bot.listen(hikari.MessageCreateEvent) | |
| async def message_listener(event) -> None: | |
| print(f"I have received a message from {event.author} in {event.channel_id}!") | |
| ``` | |
| You may also put the event's type in the decorator instead of a type annotation: | |
| ```py | |
| @bot.listen(hikari.MessageCreateEvent) | |
| async def message_listener(event) -> None: | |
| print(f"I have received a message from {event.author} in {event.channel_id}!") |
There was a problem hiding this comment.
I think it is important to note in scenarios where type annotation usage may not be feasible or possible, yes.
davfsa
added
documentation
novanai
reviewed
Mar 5, 2023
| async def message_listener(event: hikari.MessageCreateEvent) -> None: | ||
| print(f"I have received a message from {event.author} in {event.channel_id}!") | ||
|
|
||
| # -- Snip -- |
There was a problem hiding this comment.
Are the # -- Snip --'s necessary here?
Co-authored-by: Nova <110734810+novanai@users.noreply.github.com> Signed-off-by: Hyper <46067571+HyperGH@users.noreply.github.com>
|
This can most probably be merged into #1810 |
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.
Summary
Add a "Guides" section to the documentation where users new to the library are introduced to core concepts and features of the library.
The guides should be written with the assumption that the user is already familiar with Python, but not the Discord API or hikari.
Progress
If you feel like more topics should be covered, feel free to leave a comment below or create a PR to this branch!