I brought this up at IRC but didn't get any comments (maybe I posted at the wrong time).
I paste it here:
I just found out that prompter does accept HTML string, and I
can format my docstring by writing HTML in it I'm not sure if
that is intentional design or accidental, though. Interpreting
strings as raw HTML strings without escaping might cause
problem (e.g. what if a "<" just shows up in the docstring of
CL:<)?
There are several intentional design I can see:
- Use plump node uniformly. String has to be a special case and is
(a) escaped or (b) never escaped.- Use spinneret style sexp uniformly. String is naturally a subset
of spinneret style sexp and is escaped.- Status quo, use unescaped HTML string uniformly.
I like 2 the most, there's a specific problem though: for
docstrings, an S-expr won't be recognized as documentation in place
of the docstring maybe we can add a convention: if we see a quoted
form as the first form of a function/command/etc body, store it as
structured documentation?
I think this is a very important question. A dominating ontology is what usually defines the characteristic of an operating system/environment.
- UNIX: hierarchical file system and files (unstructured bag of bytes)
- Windoze: wIndOWs and a UNIX-like FS
- Emacs: Buffer and text /with text properties/ (a bit more structured, but still not very structured).
What would be a dominating ontology for Nyxt?