Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(MessageMentions): add sort order notice #3693

Merged
merged 1 commit into from Jan 14, 2020

Conversation

@almostSouji
Copy link
Member

almostSouji commented Jan 13, 2020

Please describe the changes this PR makes and why it should be merged:

Apparently the sort order of collections returned from the MessageMentions structure rise issues occasionally both on the discord server as well as the repository
#2669 and even upstream IanMitchell/aquarius#344

This PR attempts to make the sort order of mention collections clearer on the documentation to prevent this sort of misunderstanding in the future.

If the text can be clearer/improved or changed from info to warning please let me know!

Status

  • Code changes have been tested against the Discord API, or there are no code changes
  • I know how to update typings and have done so, or typings don't need updating

Semantic versioning classification:

  • This PR changes the library's interface (methods or parameters added)
    • This PR includes breaking changes (methods removed or renamed, parameters moved or removed)
  • This PR only includes non-code changes, like changes to documentation, README, etc.
* mention order returned from API
* not left to right in text
@IanMitchell

This comment has been minimized.

Copy link
Contributor

IanMitchell commented Jan 13, 2020

Thank you! I think this will help clear up a lot of confusion - a cursory search showed five or six issues opened over this over the years

@SpaceEEC SpaceEEC merged commit 7f99be7 into discordjs:master Jan 14, 2020
3 checks passed
3 checks passed
ESLint ESLint
Details
TSLint
Details
Documentation
Details
@almostSouji almostSouji mentioned this pull request Jan 18, 2020
3 of 5 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.