outmoded / lout

API documentation generator
Other
276 stars 49 forks source link

Inline single constant values #133

Closed kpdecker closed 8 years ago

kpdecker commented 9 years ago
    errorCode: Joi.string().equal(Account.USER_DOES_NOT_EXIST)

Renders as: image

Ideally we simplify this to something like

  errorCode: 'user_does_not_exist'

Potentially may want to consider inlining all enum options, i.e.:

  errorCode: one of "user_does_not_exist"

Since the type display doesn't mean too much since we only allow a valid subset of what the full type is.

Marsup commented 9 years ago

Agreed, do you want to take it ?

kpdecker commented 9 years ago

I'm playing around so I can try to do a PR for this.