mirror of
https://github.com/larvit/adf-codec.git
synced 2026-11-15 13:00:26 +01:00
Answer product-owner round 1: 0 🔴, 4 🟡 (0 misread); keep unreleased calls out of the Breaking entries and sharpen the feature page's intro
This commit is contained in:
@@ -1,8 +1,10 @@
|
||||
# What each call writes
|
||||
|
||||
`feature-table/build.mjs` writes this page from the corpus and the built package, and `./ci.sh` fails where the page differs.
|
||||
Each section sets a sample ADF document beside what each call writes for it, then reads that output back: `adfToLosslessMarkdown` with `losslessMarkdownToAdf`, `adfToPortableMarkdown` with `portableMarkdownToAdf`, `adfToHtml` with `htmlToAdf`. `holds` means the reader gives the same document, `loses` a different one, and `refused` that the writer or reader returned an error, whose code the section names.
|
||||
|
||||
Each output is read back by its format's reader. `holds` means that gives the same document, `loses` a different one, and `refused` an error whose code the example names.
|
||||
A result covers that example alone, and the examples are plain. Portable markdown drops every attribute, so a document holding one loses it even where its row says `holds`: to edit and save back, use `adfToLosslessMarkdown` and `losslessMarkdownToAdf`. An image holding an attribute, as editor-written ones do, rides the carry element in HTML, where this page shows `<img>`.
|
||||
|
||||
`./feature-table/write.sh` writes this page. Don't edit it by hand.
|
||||
|
||||
| Example | Lossless | Portable | HTML |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
Reference in New Issue
Block a user