mirror of
https://github.com/unisonweb/unison.git
synced 2024-09-11 02:25:39 +03:00
Terminate API code blocks correctly
They were missing trailing newlines, so as you can see in the diff, some transcripts had invalid output.
This commit is contained in:
parent
8416708a29
commit
179b8d1bb7
@ -432,7 +432,7 @@ run verbosity dir stanzas codebase runtime sbRuntime nRuntime config ucmVersion
|
|||||||
API apiRequests -> do
|
API apiRequests -> do
|
||||||
liftIO (output "``` api\n")
|
liftIO (output "``` api\n")
|
||||||
liftIO (for_ apiRequests apiRequest)
|
liftIO (for_ apiRequests apiRequest)
|
||||||
liftIO (output "```")
|
liftIO (output "```\n\n")
|
||||||
awaitInput
|
awaitInput
|
||||||
Ucm hide errOk cmds -> do
|
Ucm hide errOk cmds -> do
|
||||||
liftIO (writeIORef hidden hide)
|
liftIO (writeIORef hidden hide)
|
||||||
|
@ -940,4 +940,5 @@ GET /api/projects/scratch/branches/main/getDefinition?names=term
|
|||||||
},
|
},
|
||||||
"typeDefinitions": {}
|
"typeDefinitions": {}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -252,4 +252,5 @@ GET /api/projects/scratch/branches/main/find?query=joey.http
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -205,7 +205,9 @@ GET /api/projects/scratch/branches/main/getDefinition?names=%23qkhkl0n238&relati
|
|||||||
},
|
},
|
||||||
"typeDefinitions": {}
|
"typeDefinitions": {}
|
||||||
}
|
}
|
||||||
`````` unison
|
```
|
||||||
|
|
||||||
|
``` unison
|
||||||
doctest.thing.doc = {{ The correct docs for the thing }}
|
doctest.thing.doc = {{ The correct docs for the thing }}
|
||||||
doctest.thing = "A thing"
|
doctest.thing = "A thing"
|
||||||
doctest.thingalias.doc = {{ Docs for the alias, should not be displayed }}
|
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": {}
|
"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
|
``` api
|
||||||
GET /api/projects/scratch/branches/main/getDefinition?names=thing.doc&relativeTo=doctest
|
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": {}
|
"typeDefinitions": {}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -53,4 +53,5 @@ GET /api/projects/project-one/branches?prefix=branch-t
|
|||||||
"branchName": "branch-two"
|
"branchName": "branch-two"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -78,4 +78,5 @@ GET /api/projects/scratch/branches/main/namespaces/nested.names
|
|||||||
"tag": "Paragraph"
|
"tag": "Paragraph"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -131,4 +131,5 @@ GET /api/projects/scratch/branches/main/list?namespace=names&relativeTo=nested
|
|||||||
"namespaceListingFQN": "nested.names",
|
"namespaceListingFQN": "nested.names",
|
||||||
"namespaceListingHash": "#oms19b4f9s3c8tb5skeb8jii95ij35n3hdg038pu6rv5b0fikqe4gd7lnu6a1i6aq5tdh2opdo4s0sfrupvk6vfkr9lf0n752gbl8o0"
|
"namespaceListingHash": "#oms19b4f9s3c8tb5skeb8jii95ij35n3hdg038pu6rv5b0fikqe4gd7lnu6a1i6aq5tdh2opdo4s0sfrupvk6vfkr9lf0n752gbl8o0"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -667,7 +667,9 @@ GET /api/projects/scratch/branches/main/definitions/terms/by-hash/@@IO.putBytes.
|
|||||||
},
|
},
|
||||||
"tag": "Plain"
|
"tag": "Plain"
|
||||||
}
|
}
|
||||||
```## Type Summary APIs
|
```
|
||||||
|
|
||||||
|
## Type Summary APIs
|
||||||
|
|
||||||
``` api
|
``` api
|
||||||
-- data
|
-- data
|
||||||
@ -823,4 +825,5 @@ GET /api/projects/scratch/branches/main/definitions/types/by-hash/@@Nat/summary?
|
|||||||
},
|
},
|
||||||
"tag": "Data"
|
"tag": "Data"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -558,7 +558,9 @@ GET /api/projects/diffs/diff/terms?oldBranchRef=main&newBranchRef=new&oldTerm=te
|
|||||||
},
|
},
|
||||||
"project": "diffs"
|
"project": "diffs"
|
||||||
}
|
}
|
||||||
```Diff types
|
```
|
||||||
|
|
||||||
|
Diff types
|
||||||
|
|
||||||
``` api
|
``` api
|
||||||
GET /api/projects/diffs/diff/types?oldBranchRef=main&newBranchRef=new&oldType=Type&newType=Type
|
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"
|
"project": "diffs"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user