socket.c,tcpsocket.c: improve deprecation notices

stomar · stomar · commit b6db783eedb1 · 2017-11-07T20:13:00.000Z
* ext/socket/socket.c: [DOC] fix grammar in deprecation notices.
* ext/socket/tcpsocket.c: [DOC] ditto.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60709 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
diff --git a/ext/socket/socket.c b/ext/socket/socket.c
@@ -984,13 +984,13 @@ sock_sockaddr(struct sockaddr *addr, socklen_t len)
  *   Socket.gethostbyname(hostname) => [official_hostname, alias_hostnames, address_family, *address_list]
  *
  * Use Addrinfo.getaddrinfo instead.
- * This method is deprecated since following reasons:
+ * This method is deprecated for the following reasons:
  *
- * - The 3rd element of result is the address family of the first address.
- *   The address families of rest addresses are not returned.
+ * - The 3rd element of the result is the address family of the first address.
+ *   The address families of the rest of the addresses are not returned.
  * - Uncommon address representation:
  *   4/16-bytes binary string to represent IPv4/IPv6 address.
- * - gethostbyname() is may take long time and it may block other threads.
+ * - gethostbyname() may take a long time and it may block other threads.
  *   (GVL cannot be released since gethostbyname() is not thread safe.)
  * - This method uses gethostbyname() function already removed from POSIX.
  *
@@ -1012,11 +1012,11 @@ sock_s_gethostbyname(VALUE obj, VALUE host)
  *   Socket.gethostbyaddr(address_string [, address_family]) => hostent
  *
  * Use Addrinfo#getnameinfo instead.
- * This method is deprecated since following reasons:
+ * This method is deprecated for the following reasons:
  *
  * - Uncommon address representation:
  *   4/16-bytes binary string to represent IPv4/IPv6 address.
- * - gethostbyaddr() is may take long time and it may block other threads.
+ * - gethostbyaddr() may take a long time and it may block other threads.
  *   (GVL cannot be released since gethostbyname() is not thread safe.)
  * - This method uses gethostbyname() function already removed from POSIX.
  *
@@ -1164,8 +1164,8 @@ sock_s_getservbyport(int argc, VALUE *argv)
  *
  * Obtains address information for _nodename_:_servname_.
  *
- * Note that Addrinfo.getaddrinfo provides same functionality in
- * object oriented style.
+ * Note that Addrinfo.getaddrinfo provides the same functionality in
+ * an object oriented style.
  *
  * _family_ should be an address family such as: :INET, :INET6, etc.
  *
diff --git a/ext/socket/tcpsocket.c b/ext/socket/tcpsocket.c
@@ -42,11 +42,11 @@ tcp_sockaddr(struct sockaddr *addr, socklen_t len)
  *   TCPSocket.gethostbyname(hostname) => [official_hostname, alias_hostnames, address_family, *address_list]
  *
  * Use Addrinfo.getaddrinfo instead.
- * This method is deprecated since following reasons:
+ * This method is deprecated for the following reasons:
  *
- * - The 3rd element of result is the address family of the first address.
- *   The address families of rest addresses are not returned.
- * - gethostbyname() is may take long time and it may block other threads.
+ * - The 3rd element of the result is the address family of the first address.
+ *   The address families of the rest of the addresses are not returned.
+ * - gethostbyname() may take a long time and it may block other threads.
  *   (GVL cannot be released since gethostbyname() is not thread safe.)
  * - This method uses gethostbyname() function already removed from POSIX.
  *

Original file line number	Diff line number	Diff line change
`@@ -984,13 +984,13 @@ sock_sockaddr(struct sockaddr *addr, socklen_t len)`
`984`	`984`	`* Socket.gethostbyname(hostname) => [official_hostname, alias_hostnames, address_family, *address_list]`
`985`	`985`	`*`
`986`	`986`	`* Use Addrinfo.getaddrinfo instead.`
`987`		`- * This method is deprecated since following reasons:`
	`987`	`+ * This method is deprecated for the following reasons:`
`988`	`988`	`*`
`989`		`- * - The 3rd element of result is the address family of the first address.`
`990`		`- * The address families of rest addresses are not returned.`
	`989`	`+ * - The 3rd element of the result is the address family of the first address.`
	`990`	`+ * The address families of the rest of the addresses are not returned.`
`991`	`991`	`* - Uncommon address representation:`
`992`	`992`	`* 4/16-bytes binary string to represent IPv4/IPv6 address.`
`993`		`- * - gethostbyname() is may take long time and it may block other threads.`
	`993`	`+ * - gethostbyname() may take a long time and it may block other threads.`
`994`	`994`	`* (GVL cannot be released since gethostbyname() is not thread safe.)`
`995`	`995`	`* - This method uses gethostbyname() function already removed from POSIX.`
`996`	`996`	`*`
`@@ -1012,11 +1012,11 @@ sock_s_gethostbyname(VALUE obj, VALUE host)`
`1012`	`1012`	`* Socket.gethostbyaddr(address_string [, address_family]) => hostent`
`1013`	`1013`	`*`
`1014`	`1014`	`* Use Addrinfo#getnameinfo instead.`
`1015`		`- * This method is deprecated since following reasons:`
	`1015`	`+ * This method is deprecated for the following reasons:`
`1016`	`1016`	`*`
`1017`	`1017`	`* - Uncommon address representation:`
`1018`	`1018`	`* 4/16-bytes binary string to represent IPv4/IPv6 address.`
`1019`		`- * - gethostbyaddr() is may take long time and it may block other threads.`
	`1019`	`+ * - gethostbyaddr() may take a long time and it may block other threads.`
`1020`	`1020`	`* (GVL cannot be released since gethostbyname() is not thread safe.)`
`1021`	`1021`	`* - This method uses gethostbyname() function already removed from POSIX.`
`1022`	`1022`	`*`
`@@ -1164,8 +1164,8 @@ sock_s_getservbyport(int argc, VALUE *argv)`
`1164`	`1164`	`*`
`1165`	`1165`	`* Obtains address information for _nodename_:_servname_.`
`1166`	`1166`	`*`
`1167`		`- * Note that Addrinfo.getaddrinfo provides same functionality in`
`1168`		`- * object oriented style.`
	`1167`	`+ * Note that Addrinfo.getaddrinfo provides the same functionality in`
	`1168`	`+ * an object oriented style.`
`1169`	`1169`	`*`
`1170`	`1170`	`* _family_ should be an address family such as: :INET, :INET6, etc.`
`1171`	`1171`	`*`
Original file line number	Diff line number	Diff line change
`@@ -42,11 +42,11 @@ tcp_sockaddr(struct sockaddr *addr, socklen_t len)`
`42`	`42`	`* TCPSocket.gethostbyname(hostname) => [official_hostname, alias_hostnames, address_family, *address_list]`
`43`	`43`	`*`
`44`	`44`	`* Use Addrinfo.getaddrinfo instead.`
`45`		`- * This method is deprecated since following reasons:`
	`45`	`+ * This method is deprecated for the following reasons:`
`46`	`46`	`*`
`47`		`- * - The 3rd element of result is the address family of the first address.`
`48`		`- * The address families of rest addresses are not returned.`
`49`		`- * - gethostbyname() is may take long time and it may block other threads.`
	`47`	`+ * - The 3rd element of the result is the address family of the first address.`
	`48`	`+ * The address families of the rest of the addresses are not returned.`
	`49`	`+ * - gethostbyname() may take a long time and it may block other threads.`
`50`	`50`	`* (GVL cannot be released since gethostbyname() is not thread safe.)`
`51`	`51`	`* - This method uses gethostbyname() function already removed from POSIX.`
`52`	`52`	`*`