Link to ShardMessenger::chunk_guilds from the Guild.members field #683
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
arqunis
approved these changes
Aug 12, 2019
Lakelezz
requested changes
Aug 14, 2019
There was a problem hiding this comment.
Hello, thanks for your pull request :)
I personally would advice against explaining the function in the first place. The link should suffice.
My reasoning: If the function ever changes, the user will always have the updated information when clicking on the link. Furthermore, the function's documentation must be good enough to stand on its own ground.
Therefore, explaining that this functions allows to manually request remaining guild members, should be sufficient.
|
Makes sense! I tend to get a bit overexplainy. How does this look? Should it maybe be reduced to just a |
Lakelezz
approved these changes
Aug 15, 2019
|
It's fine, thanks : ) |
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.
The Guild
membersfield details that not all users might be available, but doesn't specify that how one might request that the users be made available. In addition, the method that one would use to accomplish this is kinda hard to find, being on a struct that you can write an entire program without touching once. Linking to that method from the members field might clarify this a lot. Sorry for the small PR, but I think this might be an important change (that would certainly have saved me a ton of time and confusion)