hslua-module-doclayout 1.2.1 → 1.2.1.1
raw patch · 5 files changed
+21/−13 lines, 5 filesPVP ok
version bump matches the API change (PVP)
API changes (from Hackage documentation)
Files
- CHANGELOG.md +8/−0
- LICENSE +1/−1
- hslua-module-doclayout.cabal +2/−2
- src/HsLua/Module/DocLayout.hs +9/−9
- test/test-hslua-module-doclayout.hs +1/−1
CHANGELOG.md view
@@ -3,6 +3,14 @@ `hslua-module-doclayout` uses [PVP Versioning][1]. The changelog is available [on GitHub][2]. +## 1.2.1.1++Released 2026-01-12.++- Fixed types in function documentations: Use `[[Doc]]` instead+ of `` `Doc` ``. This convention is already used in other hslua+ modules to markup internal links.+ ## 1.2.1 Released 2026-01-08.
LICENSE view
@@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020-2025 Albert Krewinkel+Copyright (c) 2020-2026 Albert Krewinkel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal
hslua-module-doclayout.cabal view
@@ -1,6 +1,6 @@ cabal-version: 2.2 name: hslua-module-doclayout-version: 1.2.1+version: 1.2.1.1 synopsis: Lua module wrapping Text.DocLayout. description: Lua module wrapping @Text.DocLayout@. homepage: https://github.com/hslua/hslua-module-doclayout@@ -9,7 +9,7 @@ license-file: LICENSE author: Albert Krewinkel maintainer: Albert Krewinkel <albert@zeitkraut.de>-copyright: © 2020-2025 Albert Krewinkel+copyright: © 2020-2026 Albert Krewinkel category: Foreign build-type: Simple extra-doc-files: README.md
src/HsLua/Module/DocLayout.hs view
@@ -410,10 +410,10 @@ concat = defun "concat" ### liftPure2 (\docs optSep -> mconcat $ maybe docs (`intersperse` docs) optSep)- <#> parameter (peekList peekDoc) "`{Doc,...}`" "docs" "list of Docs"+ <#> parameter (peekList peekDoc) "{Doc,...}" "docs" "list of Docs" <#> opt (parameter peekDoc "Doc" "sep" "separator (default: none)") =#> docResult "concatenated doc"- #? "Concatenates a list of `Doc`s."+ #? "Concatenates a list of [[Doc]]s." -- | Wraps a @'Doc'@ in double quotes double_quotes :: LuaError e => DocumentedFunction e@@ -421,7 +421,7 @@ ### liftPure Doc.doubleQuotes <#> docParam "doc" =#> docResult "`doc` enclosed by `\"` chars"- #? "Wraps a `Doc` in double quotes."+ #? "Wraps a [[Doc]] in double quotes." -- | Makes a @'Doc'@ flush against the left margin. flush :: LuaError e => DocumentedFunction e@@ -429,7 +429,7 @@ ### liftPure Doc.flush <#> docParam "doc" =#> docResult "flushed `doc`"- #? "Makes a `Doc` flush against the left margin."+ #? "Makes a [[Doc]] flush against the left margin." -- | Creates a hanging indent. hang :: LuaError e => DocumentedFunction e@@ -469,7 +469,7 @@ ### liftPure Doc.literal <#> textParam "text" "literal value" =#> docResult "doc contatining just the literal string"- #? "Creates a `Doc` from a string."+ #? "Creates a [[Doc]] from a string." -- | Indents a @'Doc'@ by the specified number of spaces. nest :: LuaError e => DocumentedFunction e@@ -478,7 +478,7 @@ <#> docParam "doc" <#> integralParam "ind" "indentation size" =#> docResult "`doc` indented by `ind` spaces"- #? "Indents a `Doc` by the specified number of spaces."+ #? "Indents a [[Doc]] by the specified number of spaces." -- | Removes leading blank lines from a @'Doc'@. nestle :: LuaError e => DocumentedFunction e@@ -486,7 +486,7 @@ ### liftPure Doc.nestle <#> docParam "doc" =#> docResult "`doc` with leading blanks removed"- #? "Removes leading blank lines from a `Doc`."+ #? "Removes leading blank lines from a [[Doc]]." -- | Makes a @'Doc'@ non-reflowable. nowrap :: LuaError e => DocumentedFunction e@@ -494,7 +494,7 @@ ### liftPure Doc.nowrap <#> docParam "doc" =#> docResult "same as input, but non-reflowable"- #? "Makes a `Doc` non-reflowable."+ #? "Makes a [[Doc]] non-reflowable." -- | Puts a @'Doc'@ in parentheses. parens :: LuaError e => DocumentedFunction e@@ -524,7 +524,7 @@ ### liftPure Doc.quotes <#> docParam "doc" =#> docResult "doc enclosed in `'`."- #? "Wraps a `Doc` in single quotes."+ #? "Wraps a [[Doc]] in single quotes." -- | Like @'rblock'@ but aligned to the right. rblock :: LuaError e => DocumentedFunction e
test/test-hslua-module-doclayout.hs view
@@ -2,7 +2,7 @@ {-# LANGUAGE TypeApplications #-} {-| Module : Main-Copyright : © 2020-2024 Albert Krewinkel+Copyright : © 2020-2026 Albert Krewinkel License : MIT Maintainer : Albert Krewinkel <albert+hslua@zeitkraut.de>