Skip to content

Commit ac0b4c3

Browse files
committed
Fix type specifiers in function documentations
1 parent ac1c4e2 commit ac0b4c3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/HsLua/Module/DocLayout.hs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -410,26 +410,26 @@ concat :: LuaError e => DocumentedFunction e
410410
concat = defun "concat"
411411
### liftPure2 (\docs optSep -> mconcat $
412412
maybe docs (`intersperse` docs) optSep)
413-
<#> parameter (peekList peekDoc) "`{Doc,...}`" "docs" "list of Docs"
413+
<#> parameter (peekList peekDoc) "{Doc,...}" "docs" "list of Docs"
414414
<#> opt (parameter peekDoc "Doc" "sep" "separator (default: none)")
415415
=#> docResult "concatenated doc"
416-
#? "Concatenates a list of `Doc`s."
416+
#? "Concatenates a list of [[Doc]]s."
417417

418418
-- | Wraps a @'Doc'@ in double quotes
419419
double_quotes :: LuaError e => DocumentedFunction e
420420
double_quotes = defun "double_quotes"
421421
### liftPure Doc.doubleQuotes
422422
<#> docParam "doc"
423423
=#> docResult "`doc` enclosed by `\"` chars"
424-
#? "Wraps a `Doc` in double quotes."
424+
#? "Wraps a [[Doc]] in double quotes."
425425

426426
-- | Makes a @'Doc'@ flush against the left margin.
427427
flush :: LuaError e => DocumentedFunction e
428428
flush = defun "flush"
429429
### liftPure Doc.flush
430430
<#> docParam "doc"
431431
=#> docResult "flushed `doc`"
432-
#? "Makes a `Doc` flush against the left margin."
432+
#? "Makes a [[Doc]] flush against the left margin."
433433

434434
-- | Creates a hanging indent.
435435
hang :: LuaError e => DocumentedFunction e
@@ -469,7 +469,7 @@ literal = defun "literal"
469469
### liftPure Doc.literal
470470
<#> textParam "text" "literal value"
471471
=#> docResult "doc contatining just the literal string"
472-
#? "Creates a `Doc` from a string."
472+
#? "Creates a [[Doc]] from a string."
473473

474474
-- | Indents a @'Doc'@ by the specified number of spaces.
475475
nest :: LuaError e => DocumentedFunction e
@@ -478,23 +478,23 @@ nest = defun "nest"
478478
<#> docParam "doc"
479479
<#> integralParam "ind" "indentation size"
480480
=#> docResult "`doc` indented by `ind` spaces"
481-
#? "Indents a `Doc` by the specified number of spaces."
481+
#? "Indents a [[Doc]] by the specified number of spaces."
482482

483483
-- | Removes leading blank lines from a @'Doc'@.
484484
nestle :: LuaError e => DocumentedFunction e
485485
nestle = defun "nestle"
486486
### liftPure Doc.nestle
487487
<#> docParam "doc"
488488
=#> docResult "`doc` with leading blanks removed"
489-
#? "Removes leading blank lines from a `Doc`."
489+
#? "Removes leading blank lines from a [[Doc]]."
490490

491491
-- | Makes a @'Doc'@ non-reflowable.
492492
nowrap :: LuaError e => DocumentedFunction e
493493
nowrap = defun "nowrap"
494494
### liftPure Doc.nowrap
495495
<#> docParam "doc"
496496
=#> docResult "same as input, but non-reflowable"
497-
#? "Makes a `Doc` non-reflowable."
497+
#? "Makes a [[Doc]] non-reflowable."
498498

499499
-- | Puts a @'Doc'@ in parentheses.
500500
parens :: LuaError e => DocumentedFunction e
@@ -524,7 +524,7 @@ quotes = defun "quotes"
524524
### liftPure Doc.quotes
525525
<#> docParam "doc"
526526
=#> docResult "doc enclosed in `'`."
527-
#? "Wraps a `Doc` in single quotes."
527+
#? "Wraps a [[Doc]] in single quotes."
528528

529529
-- | Like @'rblock'@ but aligned to the right.
530530
rblock :: LuaError e => DocumentedFunction e

0 commit comments

Comments
 (0)