Skip to content

Commit

Permalink
Apply Ryan's documentation fixes
Browse files Browse the repository at this point in the history
Co-authored-by: Ryan Scott <[email protected]>
  • Loading branch information
tomsmeding and RyanGlScott authored Jul 15, 2024
1 parent 4b3d75b commit 1225d52
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/Text/LLVM/AST.hs
Original file line number Diff line number Diff line change
@@ -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'.
Expand Down
4 changes: 2 additions & 2 deletions src/Text/LLVM/PP.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1225d52

Please sign in to comment.