Opened 5 years ago

Closed 2 years ago

#293 closed feature (invalid)

Help function in rasql

Reported by: dmisev Owned by: dmisev
Priority: minor Milestone: Future
Component: qlparser Version: 8.3
Keywords: Cc: pbaumann
Complexity: Very Hard


A help function in rasql would be useful to quickly figure out which functionality is avaialable, get quick reference for a function, etc.

Calling just help would result in a list of functions and language constructs, with function description and note if the function is deprecated. This info could be attached to query tree nodes (each node having a getHelp() method for example), so it can be easily maintained.

Calling help(function name) would give help just about the specific function.

Change History (4)

comment:1 Changed 5 years ago by abeccati

Looks like nice to have but not at major priority, would you agree triaging it to minor already?

comment:2 Changed 5 years ago by dmisev

  • Milestone set to Future
  • Priority changed from major to minor

comment:3 Changed 5 years ago by pbaumann

hm, freezing documentation into code I find difficult to maintain - and difficult to access for those who want to read about the language (assuming you don't want to duplicate documentation). This is a feature mainly useful for interactive use, so for example when ./rasql is invoked via stdin.

comment:4 Changed 2 years ago by dmisev

  • Complexity set to Very Hard
  • Resolution set to invalid
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.