fq icon indicating copy to clipboard operation
fq copied to clipboard

Better documenation

Open wader opened this issue 3 years ago • 3 comments

Feedback and ideas:

  • Don't use name/arity notation for functions unless it needed. Use name, name(arga; argb) instead
  • Add some basic functions/syntax help to --help
  • Inline documentation in go and jq source, extract it and generate documentation. Maybe use https://github.com/fadado/JBOL/blob/master/doc/JQ-Distilled.md#type-signatures and then render more user friendly versions?
  • More examples

wader avatar Jan 25 '22 15:01 wader

#110 partly solves this issue

Doctor-love avatar Jan 28 '22 08:01 Doctor-love

In master all documentation is in markdown now again

wader avatar Oct 03 '22 10:10 wader