Skip to content

Commit 548bb42

Browse files
committed
Use wikilink syntax in doc strings to mark the Doc type
1 parent 72605da commit 548bb42

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/HsLua/Module/DocLayout.hs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ render = defun "render"
247247
<#> docParam "doc"
248248
<#> opt (integralParam "colwidth" "planned maximum line length")
249249
=#> functionResult pushText "Doc" "rendered doc"
250-
#? ("Render a @'Doc'@. The text is reflowed on breakable spaces" <>
250+
#? ("Render a [[Doc]]. The text is reflowed on breakable spaces" <>
251251
"to match the given line length. Text is not reflowed if the" <>
252252
"line length parameter is omitted or nil.")
253253

@@ -269,7 +269,7 @@ offset = defun "offset"
269269
### liftPure Doc.offset
270270
<#> docParam "doc"
271271
=#> integralResult "doc width"
272-
#? "Returns the width of a `Doc` as number of characters."
272+
#? "Returns the width of a [[Doc]] as number of characters."
273273

274274
-- | Returns the minimal width of a @'Doc'@ when reflowed at
275275
-- breakable spaces.
@@ -278,7 +278,7 @@ min_offset = defun "min_offset"
278278
### liftPure Doc.minOffset
279279
<#> docParam "doc"
280280
=#> integralResult "minimal possible width"
281-
#? ("Returns the minimal width of a `Doc` when reflowed at " <>
281+
#? ("Returns the minimal width of a [[Doc]] when reflowed at " <>
282282
"breakable spaces.")
283283

284284
-- | Returns the column that would be occupied by the last laid
@@ -324,7 +324,7 @@ after_break = defun "after_break"
324324
### liftPure Doc.afterBreak
325325
<#> textParam "text" "content to include when placed after a break"
326326
=#> docResult "new doc"
327-
#? ("Creates a `Doc` which is conditionally included only if it " <>
327+
#? ("Creates a [[Doc]] which is conditionally included only if it " <>
328328
"comes at the beginning of a line.\n\n" <>
329329
"An example where this is useful is for escaping line-initial " <>
330330
"`.` in roff man.")
@@ -427,7 +427,7 @@ inside = defun "inside"
427427
<#> docParam "start"
428428
<#> docParam "end"
429429
=#> docResult "enclosed contents"
430-
#? "Encloses a `Doc` inside a start and end `Doc`."
430+
#? "Encloses a [[Doc]] inside a start and end [[Doc]]."
431431

432432
-- | Creates a block with the given width and content, aligned to
433433
-- the left.

0 commit comments

Comments
 (0)