Skip to content

Docstrings and exemplar value support

CDanis requested to merge docstrings into main

This is a first pass at two things:

  • in-schema definitions of short documentation strings & example values for fields
  • exposing a client API to access this data in the presentation layer (e.g. HIDDENPARMA)

The idea for a web presentation layer is that docstrings can become something like tooltips, and the example values can become placeholders.

In CLI tools like dbctl, these could become comments in the generated files for the edit command.

Merge request reports