Skip to content

Commit f2b982a

Browse files
authoredFeb 26, 2024··
Doc Gen: Put Summary in Quotes for Metadata (#1206)
The summary field for the metadata needs to be wrapped in quotes.
1 parent 7a91721 commit f2b982a

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed
 

‎compiler/qsc_doc_gen/src/generate_docs.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ ms.topic: {}
230230
qsharp.kind: {}
231231
qsharp.namespace: {}
232232
qsharp.name: {}
233-
qsharp.summary: {}
233+
qsharp.summary: \"{}\"
234234
---",
235235
self.uid, self.title, self.topic, kind, self.namespace, self.name, self.summary
236236
)

‎compiler/qsc_doc_gen/src/generate_docs/tests.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ fn docs_generation() {
2424
qsharp.kind: function
2525
qsharp.namespace: Microsoft.Quantum.Core
2626
qsharp.name: Length
27-
qsharp.summary: Returns the number of elements in an array.
27+
qsharp.summary: "Returns the number of elements in an array."
2828
---
2929
3030
# Length function

0 commit comments

Comments
 (0)
Please sign in to comment.