unisonweb/unison
1
0
Fork 0
mirror of https://github.com/unisonweb/unison.git synced 2024-08-15 13:30:27 +03:00
Code Issues Projects Releases Wiki Activity

Terminate API code blocks correctly

Browse Source 
They were missing trailing newlines, so as you can see in the diff, some
transcripts had invalid output.
This commit is contained in:
Greg Pfeil 2024-07-10 13:15:33 -06:00
parent 8416708a29
commit 179b8d1bb7
No known key found for this signature in database
GPG Key ID: 1193ACD196ED61F2
9 changed files with 29 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
unison-cli/src/Unison/Codebase/TranscriptParser.hs
View File

@ -432,7 +432,7 @@ run verbosity dir stanzas codebase runtime sbRuntime nRuntime config ucmVersion
API apiRequests -> do
liftIO (output "``` api\n")
liftIO (for_ apiRequests apiRequest)
liftIO (output "```")
liftIO (output "```\n\n")
awaitInput
Ucm hide errOk cmds -> do
liftIO (writeIORef hidden hide)

3
unison-src/transcripts/api-doc-rendering.output.md
View File

@ -940,4 +940,5 @@ GET /api/projects/scratch/branches/main/getDefinition?names=term
},
"typeDefinitions": {}
}
```
```

3
unison-src/transcripts/api-find.output.md
View File

@ -252,4 +252,5 @@ GET /api/projects/scratch/branches/main/find?query=joey.http
}
]
]
```
```

11
unison-src/transcripts/api-getDefinition.output.md
View File

@ -205,7 +205,9 @@ GET /api/projects/scratch/branches/main/getDefinition?names=%23qkhkl0n238&relati
},
"typeDefinitions": {}
}
`````` unison
```
``` unison
doctest.thing.doc = {{ The correct docs for the thing }}
doctest.thing = "A thing"
doctest.thingalias.doc = {{ Docs for the alias, should not be displayed }}
@ -332,7 +334,9 @@ GET /api/projects/scratch/branches/main/getDefinition?names=thing&relativeTo=doc
},
"typeDefinitions": {}
}
```If we request a doc, the api should return the source, but also the rendered doc should appear in the 'termDocs' list.
```
If we request a doc, the api should return the source, but also the rendered doc should appear in the 'termDocs' list.
``` api
GET /api/projects/scratch/branches/main/getDefinition?names=thing.doc&relativeTo=doctest
@ -507,4 +511,5 @@ GET /api/projects/scratch/branches/main/getDefinition?names=thing.doc&relativeTo
},
"typeDefinitions": {}
}
```
```

3
unison-src/transcripts/api-list-projects-branches.output.md
View File

@ -53,4 +53,5 @@ GET /api/projects/project-one/branches?prefix=branch-t
"branchName": "branch-two"
}
]
```
```

3
unison-src/transcripts/api-namespace-details.output.md
View File

@ -78,4 +78,5 @@ GET /api/projects/scratch/branches/main/namespaces/nested.names
"tag": "Paragraph"
}
}
```
```

3
unison-src/transcripts/api-namespace-list.output.md
View File

@ -131,4 +131,5 @@ GET /api/projects/scratch/branches/main/list?namespace=names&relativeTo=nested
"namespaceListingFQN": "nested.names",
"namespaceListingHash": "#oms19b4f9s3c8tb5skeb8jii95ij35n3hdg038pu6rv5b0fikqe4gd7lnu6a1i6aq5tdh2opdo4s0sfrupvk6vfkr9lf0n752gbl8o0"
}
```
```

7
unison-src/transcripts/api-summaries.output.md
View File

@ -667,7 +667,9 @@ GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@@IO.putBytes.
},
"tag": "Plain"
}
```## Type Summary APIs
```
## Type Summary APIs
``` api
-- data
@ -823,4 +825,5 @@ GET /api/projects/scratch/branches/main/definitions/types/by-hash/@@Nat/summary?
},
"tag": "Data"
}
```
```

7
unison-src/transcripts/definition-diff-api.output.md
View File

@ -558,7 +558,9 @@ GET /api/projects/diffs/diff/terms?oldBranchRef=main&newBranchRef=new&oldTerm=te
},
"project": "diffs"
}
```Diff types
```
Diff types
``` api
GET /api/projects/diffs/diff/types?oldBranchRef=main&newBranchRef=new&oldType=Type&newType=Type
@ -804,4 +806,5 @@ GET /api/projects/diffs/diff/types?oldBranchRef=main&newBranchRef=new&oldType=Ty
},
"project": "diffs"
}
```
```