Skip to content

Commit 9cdb072

Browse files
ckoparkareborden
authored andcommitted
Update haddocks for some Network.ByteString modules
This patch - Removes two occurrences of "String based network functions in Network.Socket" which were removed in v3.0 - Fixes some hyperlinks in the haddocks - Removes the old header for Network.Socket.ByteString.IO
1 parent d9c9bbc commit 9cdb072

File tree

4 files changed

+13
-27
lines changed

4 files changed

+13
-27
lines changed

Network/Socket/ByteString.hs

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@
77
-- Stability : stable
88
-- Portability : portable
99
--
10-
-- This module provides access to the BSD /socket/ interface. This
11-
-- module is generally more efficient than the 'String' based network
12-
-- functions in 'Network.Socket'. For detailed documentation, consult
13-
-- your favorite POSIX socket reference. All functions communicate
14-
-- failures by converting the error number to 'System.IO.IOError'.
10+
-- This module provides access to the BSD /socket/ interface. For detailed
11+
-- documentation, consult your favorite POSIX socket reference. All functions
12+
-- communicate failures by converting the error number to an
13+
-- 'System.IO.Error.IOError'.
1514
--
16-
-- This module is made to be imported with 'Network.Socket' like so:
15+
-- This module is made to be imported with "Network.Socket" like so:
1716
--
1817
-- > import Network.Socket
1918
-- > import Network.Socket.ByteString
@@ -86,4 +85,3 @@ sendAllTo = G.sendAllTo
8685
-- 'SockAddr' representing the address of the sending socket.
8786
recvFrom :: Socket -> Int -> IO (ByteString, SockAddr)
8887
recvFrom = G.recvFrom
89-

Network/Socket/ByteString/IO.hsc

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,14 @@
44
#include "HsNet.h"
55

66
-- |
7-
-- Module : Network.Socket.ByteString
7+
-- Module : Network.Socket.ByteString.IO
88
-- Copyright : (c) Johan Tibell 2007-2010
99
-- License : BSD-style
1010
--
1111
-- Maintainer : [email protected]
1212
-- Stability : stable
1313
-- Portability : portable
1414
--
15-
-- This module provides access to the BSD /socket/ interface. This
16-
-- module is generally more efficient than the 'String' based network
17-
-- functions in 'Network.Socket'. For detailed documentation, consult
18-
-- your favorite POSIX socket reference. All functions communicate
19-
-- failures by converting the error number to 'System.IO.IOError'.
20-
--
21-
-- This module is made to be imported with 'Network.Socket' like so:
22-
--
23-
-- > import Network.Socket hiding (send, sendTo, recv, recvFrom)
24-
-- > import Network.Socket.ByteString
25-
--
2615
module Network.Socket.ByteString.IO
2716
(
2817
-- * Send data to a socket

Network/Socket/ByteString/Lazy.hs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,12 @@
88
-- Stability : experimental
99
-- Portability : POSIX, GHC
1010
--
11-
-- This module provides access to the BSD /socket/ interface. This
12-
-- module is generally more efficient than the 'String' based network
13-
-- functions in 'Network.Socket'. For detailed documentation, consult
14-
-- your favorite POSIX socket reference. All functions communicate
15-
-- failures by converting the error number to 'System.IO.IOError'.
11+
-- This module provides access to the BSD /socket/ interface. For detailed
12+
-- documentation, consult your favorite POSIX socket reference. All functions
13+
-- communicate failures by converting the error number to an
14+
-- 'System.IO.Error.IOError'.
1615
--
17-
-- This module is made to be imported with 'Network.Socket' like so:
16+
-- This module is made to be imported with "Network.Socket" like so:
1817
--
1918
-- > import Network.Socket
2019
-- > import Network.Socket.ByteString.Lazy

Network/Socket/Internal.hs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
-- Stability : provisional
1414
-- Portability : portable
1515
--
16-
-- A module containing semi-public 'Network.Socket' internals.
17-
-- Modules which extend the 'Network.Socket' module will need to use
16+
-- A module containing semi-public "Network.Socket" internals.
17+
-- Modules which extend the "Network.Socket" module will need to use
1818
-- this module while ideally most users will be able to make do with
1919
-- the public interface.
2020
--

0 commit comments

Comments
 (0)