search

Bungie-net / api

Resources for the Bungie.net API
Other
1.22k stars 92 forks source link

Typos in Enums #822

Open ghost opened 5 years ago

ghost commented 5 years ago

The Exceptions.PlatformErrorCodes enum has a couple of typos in it, namely:

ForumExceeedMaximumRowLimit (542): should read ForumExceedMaximumRowLimit ActivityCountsDiabled (703): should be ActivityCountsDisabled

There are also a couple of "improvements" for lack of a better word: DestinyItemNotTransferrable (1660): Transferable is much more common than Transferrable DestinyItemNotTransferrableHasSideEffects (1673): Same as above ReportRequestorNotInPGCR (2701): Requester is more common than Requestor

EDIT 1/???: In BungieMembershipType, the Bungie.net type is named BungieNext, but everywhere else it's called BungieNet. It should be BungieNet everywhere, no?

vthornheart-bng commented 5 years ago

Thanks for the info! We're not going to be fixing them at this time, but I appreciate it!

vthornheart-bng commented 5 years ago

On second thought I would like to fix this - it's just a matter of effort and inconvenience for clients vs. the benefit of doing so that will likely get this punted out to a more bone-breaking API release (such as a theoretical "v3" of the API at some undisclosed point in the future). These are misspellings in the Enums itself, which means the fix is more widespread than I'd like it to be for a simple typo: fixing it up in our mobile clients, and giving any 3rd party apps ample warning for what would ultimately amount to a material change in the expected enum values should they be auto-generating their own libraries.

Because of that potential wide effect, I'm going to put this in the distant future wishlist: and we'll just have to be careful not to add to the list of typos that need fixing until we get around to this.

ghost commented 5 years ago

In that case, I'll keep updating my original post as I find more typos that would break existing clients should they be fixed, and will update the title to reflect that.