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

consistent docstring format and language #1

Open
s-ol opened this issue Mar 7, 2020 · 1 comment
Open

consistent docstring format and language #1

s-ol opened this issue Mar 7, 2020 · 1 comment
Labels
documentation missing or outdated documentation good first issue Good for newcomers library Concerns a library module or operator

Comments

@s-ol
Copy link
Owner

s-ol commented Mar 7, 2020

The reference generated from docstrings in lib/ needs a consistent format and language that helps to understand the individual ops clearly. The following bits of information need to be covered in every description:

  • what does this op do?
  • how should it be used? (give an example)
  • which arguments does this op expect?
  • what types do the arguments have to be?
  • how does this op react to incoming messages? (value, event, cold inputs?)
  • do any arguments have to be eval-time const?
  • what type will this op return?
  • does this op relate to other ops? (name them)

The docstring format should support some kind of rich styling (possibly the markdown extension that is already used to generate other doc pages), so that parameter names, example code etc. can be highlighted properly.

@s-ol s-ol added documentation missing or outdated documentation library Concerns a library module or operator and removed documentation missing or outdated documentation labels Mar 7, 2020
@s-ol
Copy link
Owner Author

s-ol commented Mar 22, 2020

The new structured meta-data introduced in e83df1a should serve this purpose, but is not powerful enough yet. After #12 has been resolved, ops should start documenting in- and output (meta)types as well as hot/cold input behaviours in a structured manner.

@s-ol s-ol added the good first issue Good for newcomers label Apr 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation missing or outdated documentation good first issue Good for newcomers library Concerns a library module or operator
Projects
None yet
Development

No branches or pull requests

1 participant