summaryrefslogtreecommitdiff
path: root/subplot.md
AgeCommit message (Collapse)AuthorFilesLines
2022-08-14feat! drop support to act as a Pandoc filterLars Wirzenius1-43/+21
When we change Subplot to take a YAML file instead of a Markdown file as input, it doesn't make sense to act as a Pandoc filter anymore: Pandoc doesn't understand our YAML file. In any case, I seem to have been the only user ever of that feature, so it won't really bother anyone else. Even so, we should treat this as a breaking change. "subplot docgen" still works as before. Sponsored-by: author
2022-08-13feat: make errors have a source errorLars Wirzenius1-2/+4
When errors have a source, i.e., an underlying error, it results in better error messages to the user. Also, refactor the way the source chain is printed, to code that is clearer to me. I will need this to for loading document metadata from an external YAML file. Sponsored-by: author
2022-07-16(subplot.md): Fix for newer pandocDaniel Silverstone1-4/+4
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2022-05-04(subplot.md): Add example scenarios covering example blocksDaniel Silverstone1-0/+57
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2022-04-26refactor: use "diagram" instead of "graph"Lars Wirzenius1-12/+12
Change everywhere to use the word "diagram" instead of "graph. Diagram seems like the better word. It's mostly used in comments and documentation, but there was one filename and one trait name that needed changing. I used "rg -iw graph" and "find -iname '*graph*'" to find everywhere that needed changing. Sponsored-by: author
2022-04-10feat! treat warnings as errors by defaultLars Wirzenius1-7/+17
Add a --merciful option to subcommands for which this matters. Adjust tests to invoke subplot with that option as necessary. Sponsored-by: author
2022-04-09'should be' feels wrong here, 'are' seems a better fitXipmix1-1/+1
2022-04-09Comma to break sentence into contrasting optionsXipmix1-1/+1
2022-04-09Reword sentence after standing back and staring a bitXipmix1-2/+2
2022-04-09Break long sentenceXipmix1-1/+1
2022-04-09Reword opening sentence and tidy up related textXipmix1-4/+3
On a first reading, this sentence seemed circular to me. After many, many rereadings, the only way I could interpret it was as shown here. Since the second paragraph is now repeating the first, prune it and rearrange the line break in the second sentence.
2022-04-09Remove full stopXipmix1-1/+1
Unusual in headings and not done elsewhere in the document
2022-03-23Clarify these two sections are closely relatedXipmix1-4/+6
2022-03-23typoXipmix1-1/+1
2022-03-16pluralXipmix1-1/+1
2022-03-16typosXipmix1-3/+3
2022-03-16tenseXipmix1-1/+1
2022-03-16trailing space in other placesXipmix1-12/+12
2022-03-16trailing space in python implsXipmix1-29/+29
2022-03-16mdashXipmix1-1/+1
2022-02-19(doc): Add scenario runner comparison 'table'Daniel Silverstone1-0/+26
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2022-01-26feat: automatically use "and" on outputLars Wirzenius1-11/+15
This changes typesetting of scenarios so that when two adjacent scenario steps have the same keyword, "and" is used on the second one. This means that when input has when I do foo when I do bar the output will have when I do foo and I do bar I didn't bother to make this configurable. I don't feel that level of configuration is good. The "keyword aliases" scenario is repurposed to verify this. Sponsored-by: author
2022-01-01subplotlib: Run subplot.md in Rust tooDaniel Silverstone1-0/+2
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-11-27feat: warn about unused embedded filesLars Wirzenius1-0/+26
This is merely a warning, for now, to stderr. subplot.md has two embedded files used as examples, and I'm too tired to add a way to indicate that it's OK for a specific file to not be used. That should probably be added later, though. Sponsored-by: author
2021-11-27fix: markup of embedded markdown in subplot.mdLars Wirzenius1-2/+2
The embedded file with markdown was insufficiently escaped. Sponsored-by: author
2021-11-19subplots: Upgrade metadata for polyglot docsDaniel Silverstone1-68/+67
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-11-19subplot.md: Fix up test cases to work with intermediate polyglot docsDaniel Silverstone1-5/+9
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-10-08subplot.md: Add a missing scenario in test inputDaniel Silverstone1-0/+31
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-09-18chore: Fix up embedded metadata blocks in subplot.mdDaniel Silverstone1-58/+60
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-09-16feat! parse Markdown input with pull-cmark instead of PandocLars Wirzenius1-19/+17
This is a first step towards being able to use Subplot codegen from a project's build.rs, and with only pure-Rust build dependencies. Replace Pandoc for parsing Markdown input with pulldown-cmark. This is mostly a drop-in replacement, but not entirely. The YAML parsing is more strict now. Note that this is a breaking change. Some subplots that used to work, and still work with docgen, no longer work with the new parser. Major differences are: * Only specific fields are supported. All the Markdown files in the Subplot source tree work. If anything else is needed, and it likely is, the new parser needs to be extended. * The bindings, functions, classes, and bibliography fields MUST be lists of strings. A single string value will no longer work. Sponsored-by: pep.foundation
2021-09-13Merge branch 'multi-lang-docs' into 'main'Lars Wirzenius1-39/+152
Implement polyglot bindings See merge request subplot/subplot!210
2021-09-11subplot.md: Improve bindings documentationDaniel Silverstone1-10/+50
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-09-09fix: handle most inline markup in metadata titlesLars Wirzenius1-0/+22
Actually, we only didn't handle `foo` code markup. Sponsored-by: author
2021-09-07subplot: Properly support polyglot bindingsDaniel Silverstone1-0/+21
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-09-07bindings: Parse polyglot bindingsDaniel Silverstone1-29/+81
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-08-24fix: arch diagram says steps can be written in Bash, Python, RustLars Wirzenius1-6/+6
Sponsored-by: author
2021-07-31docs: explain concepts, suggest a workflowLars Wirzenius1-0/+44
Sponsored-by: author
2021-07-20feat: when more than one bindings match a step, list all of themLars Wirzenius1-2/+19
Sponsored-by: author
2021-07-13Fix implemented typoRichard Maw1-1/+1
2021-07-12Fix html typoRichard Maw1-1/+1
I'm assuming this was accidental since the intended error is a missing input file.
2021-07-12Fix typo of officiallyRichard Maw1-1/+1
Could've gone either way to official or officially but I guessed probably meant to be officially, since "official stamped" implies separate attributes which would otherwise be comma or and separated while "officially stamped" is a compound attribute.
2021-07-12Fix typo in precond_fooRichard Maw1-2/+2
I'm assuming these were meant to be _done rather than _none since later functions use _done and the names are close together.
2021-07-12Fix typoRichard Maw1-1/+1
2021-07-12Make it a little more obvious file helpers return contentsRichard Maw1-2/+2
While reading through the lack of examples left it not obvious whether the embedded file helpers returned a path to a resource or temporary file, or the contents of the file itself.
2021-06-11subplot.md: Test JSON should be sortedDaniel Silverstone1-7/+7
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-06-09fix: typos in architecture diagramsLars Wirzenius1-2/+2
Sponsored-by: author
2021-05-01bin: sp-filter -> subplot-filterDaniel Silverstone1-7/+7
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-05-01subplot: Add delay step in some scenariosDaniel Silverstone1-0/+4
In order to work on filesystems where the time granularity is not sub-second, some scenarios need to wait a bit. Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-04-24subplot.md: Document scenario language a bit moreDaniel Silverstone1-0/+76
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
2021-04-09subplot.md: Use subplot extract rather than sp-extractDaniel Silverstone1-2/+2
Signed-off-by: Daniel Silverstone <dsilvers@digital-scurf.org>
generated by cgit v1.2.1 (git 2.18.0) at 2024-05-12 12:46:09 +0000