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

Improve slightly unintuitive behavior of enum "description" field #18

Open
levi opened this issue Mar 9, 2017 · 0 comments
Open

Improve slightly unintuitive behavior of enum "description" field #18

levi opened this issue Mar 9, 2017 · 0 comments
Milestone

Comments

@levi
Copy link
Contributor

levi commented Mar 9, 2017

My intuition was to use the field "description" on an enum value to describe the purpose of the value. However, "description" is used to generate the enum name. It seems like it might make more sense to decouple name and description.

Setting a description like this:

    "enum": [
       { "default" : "unknown", "description" : "Default value. This is not a value that the API will return."},

Generates this output which doesn't compile:

    typedef NS_ENUM(NSInteger, PIPinSafetyStatusRedirectStatusType) {
        PIPinSafetyStatusRedirectStatusTypeDefault Value. This Is Not A Value That The Api Will Return. /* unknown */,
@levi levi added this to the 1.1 milestone Mar 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant