Skip to content

Commit 74d5cd9

Browse files
committed
Fix typos in docstrings
1 parent c854fbb commit 74d5cd9

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/HsLua/Module/DocLayout.hs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Copyright : © 2020-2024 Albert Krewinkel
1010
License : MIT
1111
Maintainer : Albert Krewinkel <albert+hslua@zeitkraut.de>
1212
13-
Provides a Lua module which wraps @'Text.DocLayout'@. The @Doc'
13+
Provides a Lua module which wraps @'Text.DocLayout'@. The @'Doc'@
1414
type is specialized to @'Text'@.
1515
1616
This module defines orphan instances for @Doc Text@.
@@ -312,7 +312,7 @@ real_length = defun "real_length"
312312
<#> textParam "str" "UTF-8 string to measure"
313313
=#> integralResult "text length"
314314
#? ("Returns the real length of a string in a monospace font: " <>
315-
"0 for a combining chaeracter, 1 for a regular character, " <>
315+
"0 for a combining character, 1 for a regular character, " <>
316316
"2 for an East Asian wide character.")
317317

318318
--
@@ -354,11 +354,11 @@ braces :: LuaError e => DocumentedFunction e
354354
braces = defun "braces"
355355
### liftPure Doc.braces
356356
<#> docParam "doc"
357-
=#> docResult "doc enclosed by {}."
357+
=#> docResult "`doc` enclosed by {}."
358358
#? "Puts the `doc` in curly braces."
359359

360360
-- | Puts a @'Doc'@ in square brackets.
361-
brackets :: LuaError e => DocumentedFunction e -- Doc Text -> Lua (Doc Text)
361+
brackets :: LuaError e => DocumentedFunction e
362362
brackets = defun "brackets"
363363
### liftPure Doc.brackets
364364
<#> docParam "doc"
@@ -371,7 +371,7 @@ cblock = defun "cblock"
371371
### liftPure2 (flip Doc.cblock)
372372
<#> docParam "doc"
373373
<#> integralParam "width" "block width in chars"
374-
=#> docResult ("doc, aligned centered in a block with max" <>
374+
=#> docResult ("doc, aligned centered in a block with max " <>
375375
"`width` chars per line.")
376376
#? ("Creates a block with the given width and content, " <>
377377
"aligned centered.")
@@ -511,7 +511,7 @@ rblock = defun "rblock"
511511
### liftPure2 (flip Doc.rblock)
512512
<#> docParam "doc"
513513
<#> integralParam "width" "block width in chars"
514-
=#> docResult ("doc, right aligned in a block with max" <>
514+
=#> docResult ("doc, right aligned in a block with max " <>
515515
"`width` chars per line.")
516516
#? ("Creates a block with the given width and content, " <>
517517
"aligned to the right.")

0 commit comments

Comments
 (0)