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

Create documentation for TAP output #70

Closed
AntonetteShibani opened this issue Oct 24, 2017 · 1 comment
Closed

Create documentation for TAP output #70

AntonetteShibani opened this issue Oct 24, 2017 · 1 comment
Labels
Milestone

Comments

@AntonetteShibani
Copy link

Can we have documentation on what features are outputted from TAP please? We will need information on what each module does and if the output is at sentence or word level, since the modules work at different levels. Also, the TAP Athanor tags, for example, are different from the XIP parser analytical tags - can we have doc on what they mean?

@andrewresearch
Copy link
Member

Thanks for opening this issue @AntonetteShibani. We definitely need all features documented, however this is going to need to be broken into many issues, not just one 😄 .

My recommendation is that each query is documented in two ways:

  1. An example Jupyter notebook that shows how it works and what it does (there are already issues created for existing features).
  2. An entry in the docs user section that explains the feature and points to the Jupyter notebook as an example of how to use it.

@andrewresearch andrewresearch added this to the 3.2 milestone Nov 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants