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

Document doc + doc-ref usage #357

Closed
1 of 2 tasks
GreyCat opened this issue Feb 13, 2018 · 2 comments
Closed
1 of 2 tasks

Document doc + doc-ref usage #357

GreyCat opened this issue Feb 13, 2018 · 2 comments
Assignees
Milestone

Comments

@GreyCat
Copy link
Member

GreyCat commented Feb 13, 2018

Current we only have a very simple doc tag introduction in the first chapter of user guide, and verbose enums section that mentions doc for enum values.

We need to document these properly:

  • in user guide
  • in reference and/or spec

Cc @julie-bsx, original discussion was in #356.

@GreyCat GreyCat self-assigned this Feb 14, 2018
@GreyCat
Copy link
Member Author

GreyCat commented Feb 15, 2018

Partially done, at least in the user guide: http://doc.kaitai.io/user_guide.html#ksy-documentation

@GreyCat GreyCat added this to the v0.9 milestone Mar 6, 2018
@GreyCat
Copy link
Member Author

GreyCat commented Apr 18, 2019

Hopefully, we'll be retiring hand-written text ksy spec soon in favor of JSON schema introduced by @dar2355 in kaitai-io/kaitai_struct_webide#84, so I won't be updating ksy_reference. Closing this one as done.

@GreyCat GreyCat closed this as completed Apr 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants