[Git][ghc/ghc][master] ghc-internal: Fix a few cases of missing Haddock markup

Marge Bot (@marge-bot) gitlab at gitlab.haskell.org
Sat Nov 23 04:36:12 UTC 2024



Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
454ce957 by Ben Gamari at 2024-11-22T23:35:15-05:00
ghc-internal: Fix a few cases of missing Haddock markup

- - - - -


1 changed file:

- libraries/ghc-internal/src/GHC/Internal/IO/Handle/FD.hs


Changes:

=====================================
libraries/ghc-internal/src/GHC/Internal/IO/Handle/FD.hs
=====================================
@@ -368,11 +368,11 @@ fdToHandle' fdint mb_type is_socket filepath iomode binary = do
   mkHandleFromFD fd fd_type filepath iomode is_socket enc
 
 
--- | Turn an existing file descriptor into a Handle.  This is used by
+-- | Turn an existing file descriptor into a 'Handle'.  This is used by
 -- various external libraries to make Handles.
 --
--- Makes a binary Handle.  This is for historical reasons; it should
--- probably be a text Handle with the default encoding and newline
+-- Makes a binary 'Handle'.  This is for historical reasons; it should
+-- probably be a text 'Handle' with the default encoding and newline
 -- translation instead.
 fdToHandle :: Posix.FD -> IO Handle
 fdToHandle fdint = do
@@ -389,8 +389,8 @@ fdToHandle fdint = do
    mkHandleFromFD fd fd_type fd_str iomode False{-non-block-}
                   Nothing -- bin mode
 
--- | Turn an existing Handle into a file descriptor. This function throws an
--- IOError if the Handle does not reference a file descriptor.
+-- | Turn an existing 'Handle' into a file descriptor. This function throws an
+-- 'IOError' if the 'Handle' does not reference a file descriptor.
 --
 -- @since base-4.10.0.0
 handleToFd :: Handle -> IO FD.FD



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/454ce95735f1b275a4774c7b3b5e2cd773639922

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/454ce95735f1b275a4774c7b3b5e2cd773639922
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20241122/ce015ed0/attachment-0001.html>


More information about the ghc-commits mailing list