W3C home > Mailing lists > Public > public-webrtc-logs@w3.org > June 2018

Re: [webrtc-pc] rename RTCIceCandidate.ip to address?

From: Eric Shepherd via GitHub <sysbot+gh@w3.org>
Date: Fri, 22 Jun 2018 20:04:34 +0000
To: public-webrtc-logs@w3.org
Message-ID: <issue_comment.created-399566499-1529697873-sysbot+gh@w3.org>
FWIW, from a docs standpoint, I agree with this proposal to rename `ip` to `address`, for a couple of reasons:

1. As @fippo notes, if anyone implements a scenario in which the address is not an IP address, the name becomes obsolescent.
2. This one sounds frivolous but I'm actually serious: property names as short as `ip` are an oddity in documentation, in that they can be difficult to read and to differentiate, potentially resulting in developers missing details as they read. When possible, I feel that 3 or 4 characters is a practical minimum for property names, with certain exceptions like coordinate axis names in some cases.

GitHub Notification of comment by a2sheppy
Please view or discuss this issue at https://github.com/w3c/webrtc-pc/issues/1913#issuecomment-399566499 using your GitHub account
Received on Friday, 22 June 2018 20:04:36 UTC

This archive was generated by hypermail 2.4.0 : Saturday, 6 May 2023 21:19:44 UTC