Webhooks docs update #85
Merged
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
changed some sentences for (hopefully) more clarity changed `eventType` to "event Type" (no `eventType` in any of the code) fixed capitalization, punctuation, and removed unnecessary hyphens.
gabek
reviewed
Sep 21, 2022
content/thirdparty/webhooks.md
Outdated
| "previousNames": ["lazyDaisy"] | ||
| "previousNames": ["lazyDaisy"], | ||
| "nameChangedAt": "2022-09-19T12:33:59.42313245+02:00", | ||
| "isBot": False, |
There was a problem hiding this comment.
Not sure how the f in False got capitalized, but could you fix that up for all of them?
|
Yeah, it looks good aside from the rogue capitals in the JSON examples. I find the changes to be completely readable, thank you for taking some time to polish it up! This kind of stuff really makes a difference when people are trying to implement APIs, as I'm sure you discovered when doing it yourself :) |
|
good catch with the capitalization, fixed it. |
|
Thank you so much! 🥇 |
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.
When working on my bot, I noticed the webhooks docs were a little outdated.
I updated the example jsons to include new fields that they now have, fixed their indentation, and included a new
VISIBILITY-UPDATEexample since the json is now completely different from the old docs.I also did some updates on the wording on the page -- tried to fix capitalization/punctuation mistakes, and then update the sentences to be more readable. I'm not 100% happy with all the changes I made, so they don't need to be included if you don't like them. (Or if anyone has an idea on how to further improve them...)