search

denismaier / pandocliterateschema

0 stars 0 forks source link

split vs merged (literate) #1

Open bdarcus opened 4 years ago

bdarcus commented 4 years ago

As I'm thinking about this, putting down some notes in a few issues here.

First, whether to do literate.

As I think about this more, I don't think we should.

The reason is that XML is unique compared to other language, in that we want to embed documentation within the schema, to enable validating autocomplete editing.

And the purpose of those doc strings may overlap with, but also diverge from, the purposes of the spec, which is aimed more (I think) at developers.

bdarcus commented 4 years ago

Interestingly, the CommonMark spec (that I mention in #3) embeds the test suite within the spec.

denismaier commented 4 years ago

The reason is that XML is unique compared to other language, in that we want to embed documentation within the schema, to enable validating autocomplete editing.

And the purpose of those doc strings may overlap with, but also diverge from, the purposes of the spec, which is aimed more (I think) at developers.

Both good points.