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

API Docs are Incorrect #936

Closed
travigd opened this issue May 29, 2020 · 1 comment
Closed

API Docs are Incorrect #936

travigd opened this issue May 29, 2020 · 1 comment

Comments

@travigd
Copy link

@travigd travigd commented May 29, 2020

I'm just going to give an example of a talk from JuliaCon 2019.

The documented type for submission_type is `string, but it's (apparently?) an object with translations based on locales.

  "submission_type": {
    "en": "Lightning Talk"
  }

Duration is documented to be a number, but it's actually a time-string.

  "duration": "00:10"

Additionally, which fields are optional is not well documented (a few fields mention in the description that they're Available if XYZ, but it would be nice to include that in the type (e.g. ?string) as well).

@rixx
Copy link
Member

@rixx rixx commented May 29, 2020

Thank you for the feedback! I adjusted the documentation so that multi-lingual strings are marked as such.

The incorrect duration field is a bug that I will also fix, to be included in the next release.

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

2 participants