[Git][ghc/ghc][master] Fix doc typos in libraries/base/GHC

[Marge Bot (@marge-bot)]

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


Commits:
dae514f9 by tocic at 2023-04-21T13:31:21-04:00
Fix doc typos in libraries/base/GHC

- - - - -


6 changed files:

- libraries/base/GHC/IO/Device.hs
- libraries/base/GHC/IO/Encoding.hs
- libraries/base/GHC/IO/Handle.hs
- libraries/base/GHC/IO/SubSystem.hs
- libraries/base/GHC/List.hs
- libraries/base/GHC/TypeNats.hs


Changes:

=====================================
libraries/base/GHC/IO/Device.hs
=====================================
@@ -35,7 +35,7 @@ import {-# SOURCE #-} GHC.IO.Exception ( unsupportedOperation )
 
 -- | A low-level I/O provider where the data is bytes in memory.
 --   The Word64 offsets currently have no effect on POSIX system or consoles
---   where the implicit behaviour of the C runtime is assume to move the file
+--   where the implicit behaviour of the C runtime is assumed to move the file
 --   pointer on every read/write without needing an explicit seek.
 class RawIO a where
   -- | Read up to the specified number of bytes starting from a specified
@@ -107,7 +107,7 @@ class IODevice a where
 
   -- | some devices (e.g. terminals) support a "raw" mode where
   -- characters entered are immediately made available to the program.
-  -- If available, this operations enables raw mode.
+  -- If available, this operation enables raw mode.
   setRaw :: a -> Bool -> IO ()
   setRaw _ _ = ioe_unsupportedOperation
 


=====================================
libraries/base/GHC/IO/Encoding.hs
=====================================
@@ -268,7 +268,7 @@ char8 = Latin1.latin1
 --
 --      2. If the underlying encoding is not itself roundtrippable, this mechanism
 --         can fail. Roundtrippable encodings are those which have an injective mapping
---         into Unicode. Almost all encodings meet this criteria, but some do not. Notably,
+--         into Unicode. Almost all encodings meet this criterion, but some do not. Notably,
 --         Shift-JIS (CP932) and Big5 contain several different encodings of the same
 --         Unicode codepoint.
 --


=====================================
libraries/base/GHC/IO/Handle.hs
=====================================
@@ -193,7 +193,7 @@ hLookAhead handle =
 --
 --  * if @hdl@ is writable, the buffer is flushed as for 'hFlush';
 --
---  * if @hdl@ is not writable, the contents of the buffer is discarded.
+--  * if @hdl@ is not writable, the contents of the buffer are discarded.
 --
 -- This operation may fail with:
 --
@@ -296,7 +296,7 @@ hFlush handle = wantWritableHandle "hFlush" handle flushWriteBuffer
 
 -- | The action 'hFlushAll' @hdl@ flushes all buffered data in @hdl@,
 -- including any buffered read data.  Buffered read data is flushed
--- by seeking the file position back to the point before the bufferred
+-- by seeking the file position back to the point before the buffered
 -- data was read, and hence only works if @hdl@ is seekable (see
 -- 'hIsSeekable').
 --


=====================================
libraries/base/GHC/IO/SubSystem.hs
=====================================
@@ -39,7 +39,7 @@ infixl 7 <!>
 
 -- | Conditionally execute an action depending on the configured I/O subsystem.
 -- On POSIX systems always execute the first action.
--- On windows execute the second action if WINIO as active, otherwise fall back to
+-- On Windows execute the second action if WINIO as active, otherwise fall back to
 -- the first action.
 conditional :: a -> a -> a
 #if defined(mingw32_HOST_OS)


=====================================
libraries/base/GHC/List.hs
=====================================
@@ -1084,7 +1084,7 @@ splitAt n ls
 #endif /* USE_REPORT_PRELUDE */
 
 -- | 'span', applied to a predicate @p@ and a list @xs@, returns a tuple where
--- first element is longest prefix (possibly empty) of @xs@ of elements that
+-- first element is the longest prefix (possibly empty) of @xs@ of elements that
 -- satisfy @p@ and second element is the remainder of the list:
 --
 -- >>> span (< 3) [1,2,3,4,1,2,3,4]


=====================================
libraries/base/GHC/TypeNats.hs
=====================================
@@ -68,7 +68,7 @@ import GHC.TypeNats.Internal(CmpNat)
 
 -- | A type synonym for 'Natural'.
 --
--- Prevously, this was an opaque data type, but it was changed to a type
+-- Previously, this was an opaque data type, but it was changed to a type
 -- synonym.
 --
 -- @since 4.16.0.0



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

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/dae514f9835f7fe8e6643f8759cc4d0b0af9a657
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/20230421/6151fbf0/attachment-0001.html>