From 1225d528f87efd496344085e26ff755914c61451 Mon Sep 17 00:00:00 2001 From: Tom Smeding Date: Mon, 15 Jul 2024 21:39:47 +0200 Subject: [PATCH] Apply Ryan's documentation fixes Co-authored-by: Ryan Scott --- src/Text/LLVM/AST.hs | 2 +- src/Text/LLVM/PP.hs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Text/LLVM/AST.hs b/src/Text/LLVM/AST.hs index 1193846..f3d09b1 100644 --- a/src/Text/LLVM/AST.hs +++ b/src/Text/LLVM/AST.hs @@ -1,7 +1,7 @@ {- | Because this library supports many LLVM versions, it is possible to construct an AST with the types in this module that only some LLVM versions will accept. -These cases are usually documented in the haddocks for the relevant data types. +These cases are usually documented in the Haddocks for the relevant data types. When trying to pretty-print constructions that are unsupported by the current LLVM version, pretty-printing may 'error'. diff --git a/src/Text/LLVM/PP.hs b/src/Text/LLVM/PP.hs index a25fbb0..184e7fc 100644 --- a/src/Text/LLVM/PP.hs +++ b/src/Text/LLVM/PP.hs @@ -1369,8 +1369,8 @@ structBraces body = char '{' <+> body <+> char '}' ppMaybe :: Fmt a -> Fmt (Maybe a) ppMaybe = maybe empty --- | Throw an error if the ?config version is older than the given version. The --- String indicates the constructor that is unavailable. +-- | Throw an error if the @?config@ version is older than the given version. The +-- String indicates which constructor is unavailable in the error message. onlyOnLLVM :: (?config :: Config) => LLVMVer -> String -> a -> a onlyOnLLVM fromVer name | llvmVer >= fromVer = id