Commit Graph

15 Commits

Author SHA1 Message Date
Greg Pfeil
179b8d1bb7
Terminate API code blocks correctly
They were missing trailing newlines, so as you can see in the diff, some
transcripts had invalid output.
2024-07-10 14:09:11 -06:00
Greg Pfeil
0031542faf
Add a space before code block info strings
This is for consistency with the `cmark` style. Now the blocks we still
pretty-print ourselves will match the bulk of them that `cmark`
produces.
2024-07-10 13:56:07 -06:00
Greg Pfeil
1dc181b99a
Update the transcripts with cmark
`cmark`’s pretty-printer matches our output pretty well, with a few differences:
- it puts a space between the fence and the info string for in code blocks;
- it prefers `-` over `*` for bulleted lists (as do I) and it indents them;
- it `\`-escapes certain chars very conservatively;
- it prefers indented/unfenced code blocks if there is no info string; and
- it prefers `*` over `_` (unlike any sane person).

This also shows how the change fixes a number of issues:
- fix2158-1.output.md also illustrates how this change fixes #1809;
- alias-many.output.md and input-parse-errors.output.md show how fenced
  code blocks without an info string would use the beginning of the
  content as the info string;
- transcripts-round-trip/main.output.md shows how output blocks for
  generated `unison` stanzas (which could contain nested fenced blocks)
  might not have long-enough fences; and
- error-messages.output.md and generic-parse-errors.output.md show how
  Unison errors were reported on the wrong line number (and thus the
  printed error lines were also incorrect).
2024-07-10 13:37:51 -06:00
Chris Penner
47a3a01fbe Fix up api transcripts 2024-06-27 10:25:16 -07:00
Chris Penner
370793c58e Update transcripts for non-project-code 2023-08-11 17:52:21 -07:00
Chris Penner
b2817a6888 Update transcripts 2022-10-11 10:18:25 -06:00
Chris Penner
c6a8b48437 Re-rerun transcripts 2022-09-29 16:17:45 -06:00
Chris Penner
32ea533d62
Update transcripts (#3427) 2022-09-19 10:31:34 -06:00
Chris Penner
2749f186a9
Type Summaries (#3411)
* Add type summaries

* More summary transcripts

* Update transcripts
2022-09-15 10:25:34 -06:00
Chris Penner
ab913ee4b0 by_name -> qualified 2022-09-13 10:35:06 -06:00
Chris Penner
17d9790f94 Add transcripts for signature width 2022-09-12 11:33:42 -06:00
Chris Penner
e997cedded Update transcript output 2022-09-09 15:43:55 -06:00
Chris Penner
4e77412f36 Fix types for constructors 2022-09-09 15:31:21 -06:00
Chris Penner
c0178cccf3 Add more tests 2022-09-09 15:04:39 -06:00
Chris Penner
e252ffba47 Add API summaries transcript 2022-09-09 14:53:29 -06:00