Forum: Ruby-core [ruby-trunk - Bug #7105][Open] Socket documentation fix

Issue #7105 has been reported by davidbalbert (David Albert).

----------------------------------------
Bug #7105: Socket documentation fix
https://bugs.ruby-lang.org/issues/7105

Author: davidbalbert (David Albert)
Status: Open
Priority: Normal
Assignee:
Category: DOC
Target version:
ruby -v: 2.0.0dev


The "Quick start" section of the Socket documentation refers to the 
Socket::INET constant, which doesn't exist. I've attached a small patch 
changing the reference to Socket::AF_INET, which seems consistent with 
the rest of the documentation (the alternative would be Socket::PF_INET, 
which has the same value).

Issue #7105 has been updated by zzak (Zachary Scott).

Assignee set to zzak (Zachary Scott)
Target version set to 2.0.0


----------------------------------------
Bug #7105: Socket documentation fix
https://bugs.ruby-lang.org/issues/7105#change-30126

Author: davidbalbert (David Albert)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0dev


The "Quick start" section of the Socket documentation refers to the 
Socket::INET constant, which doesn't exist. I've attached a small patch 
changing the reference to Socket::AF_INET, which seems consistent with 
the rest of the documentation (the alternative would be Socket::PF_INET, 
which has the same value).

Issue #7105 has been updated by zzak (Zachary Scott).


Hello,
I've discussed this with another mri committer, and we've come to the 
conclusion that the example should use AF_INET, as socket(2) suggests:

"The  manifest  constants  used under 4.x BSD for protocol families are 
PF_UNIX, PF_INET, etc., while AF_UNIX etc. are used for address 
families.  However, already the BSD man page promises: "The protocol 
family generally is the same as the address family", and subsequent 
standards use AF_* everywhere."

PF_INET is just an alias.

I will commit this patch if there are no obligations. Thank you for your 
contribution David.
----------------------------------------
Bug #7105: Socket documentation fix
https://bugs.ruby-lang.org/issues/7105#change-30592

Author: davidbalbert (David Albert)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: DOC
Target version: 2.0.0
ruby -v: 2.0.0dev


The "Quick start" section of the Socket documentation refers to the 
Socket::INET constant, which doesn't exist. I've attached a small patch 
changing the reference to Socket::AF_INET, which seems consistent with 
the rest of the documentation (the alternative would be Socket::PF_INET, 
which has the same value).