Add deprecation notice to some UPPER_CASE enums. #1036
Merged
+42
−0
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
hugbubby
approved these changes
Jul 29, 2018
There was a problem hiding this comment.
Reviewed 2 of 2 files at r1.
Reviewable status: 0 of 1 LGTMs obtained
hugbubby
approved these changes
Jul 29, 2018
iphydf
force-pushed
the
deprecate-uppercase-enum-types
branch
from
b180373
to
5197c0e
Compare
robinlinden
approved these changes
Aug 3, 2018
There was a problem hiding this comment.
Reviewed 2 of 2 files at r1.
Reviewable status: 1 of 2 LGTMs obtained (waiting on @JFreegman)
iphydf
force-pushed
the
deprecate-uppercase-enum-types
branch
3 times, most recently
from
215276d
to
fceee56
Compare
JFreegman
approved these changes
Aug 10, 2018
There was a problem hiding this comment.
Reviewed 1 of 2 files at r1, 2 of 2 files at r2.
Reviewable status: 1 of 2 LGTMs obtained (waiting on @sudden6)
sudden6
approved these changes
Aug 10, 2018
There was a problem hiding this comment.
Reviewed 2 of 2 files at r2.
Reviewable status:complete! 1 of 1 LGTMs obtained
iphydf
force-pushed
the
deprecate-uppercase-enum-types
branch
2 times, most recently
from
13bd527
to
af3edff
Compare
The enumerators won't change, but the type name will change in 0.3.0. Reasoning: - Type names in toxcore start with an uppercase letter and either have at least one lowercase letter in them, or are less than 4 characters long. - Constants consist of 4 or more uppercase letters or underscores. By these rules, "DHT" is a type name, but "TOX_USER_STATUS" is a constant. We provide Tox_User_Status as an alternative for now, and will switch to that in 0.3.0, removing the UPPER_CASE versions.
iphydf
force-pushed
the
deprecate-uppercase-enum-types
branch
from
af3edff
to
503d9f7
Compare
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 enumerators won't change, but the type name will change in 0.3.0.
Reasoning:
least one lowercase letter in them, or are less than 4 characters long.
By these rules, "DHT" is a type name, but "TOX_USER_STATUS" is a
constant. We provide Tox_User_Status as an alternative for now, and will
switch to that in 0.3.0, removing the UPPER_CASE versions.
This change is