[go: nahoru, domu]

Skip to content
This repository has been archived by the owner on Nov 16, 2021. It is now read-only.

Issues with the 2019-11-17 specification #21

Open
Rami-Sabbagh opened this issue Dec 26, 2019 · 4 comments
Open

Issues with the 2019-11-17 specification #21

Rami-Sabbagh opened this issue Dec 26, 2019 · 4 comments
Assignees
Labels
bug Something isn't working

Comments

@Rami-Sabbagh
Copy link
Collaborator
Rami-Sabbagh commented Dec 26, 2019

I've read the specification today, after a while of no updates, and I've noticed the following issues for now:

  • The simple types miss the "thread" type, which is the coroutines.
  • There's a miss-spelling at line 12 (descripts -> describes)
  • There are some structures with fullDescription instead of longDescription, it has to be clearified that the fullDescription is meant to replace the shortDescription when the documentation is expanded.
  • The multiple usage variant of method structure has both note and notes fields
  • The returns of a method need a literal boolean field for indicating that
@Rami-Sabbagh Rami-Sabbagh added the bug Something isn't working label Dec 26, 2019
@Rami-Sabbagh Rami-Sabbagh self-assigned this Dec 26, 2019
@Rami-Sabbagh
Copy link
Collaborator Author

Found another issue:

  • There are some structures with fullDescription instead of longDescription

@Rami-Sabbagh
Copy link
Collaborator Author
  • The multiple usage variant of method structure has both note and notes fields

@Rami-Sabbagh
Copy link
Collaborator Author
  • The returns of a method need a literal boolean field for indicating that

@Rami-Sabbagh
Copy link
Collaborator Author

It turns out the the fullDescription is named that way because it'll replace the shortDescription when displayed

  • That has to be cleared out in the specification

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant