From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-Status: No, score=-3.9 required=3.0 tests=AWL,BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_PASS,UNPARSEABLE_RELAY shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from neon.ruby-lang.org (neon.ruby-lang.org [221.186.184.75]) by dcvr.yhbt.net (Postfix) with ESMTP id 4E3591F5AE for ; Mon, 27 Jul 2020 19:22:59 +0000 (UTC) Received: from neon.ruby-lang.org (localhost [IPv6:::1]) by neon.ruby-lang.org (Postfix) with ESMTP id CB91A1209A7; Tue, 28 Jul 2020 04:22:25 +0900 (JST) Received: from xtrwkhkc.outbound-mail.sendgrid.net (xtrwkhkc.outbound-mail.sendgrid.net [167.89.16.28]) by neon.ruby-lang.org (Postfix) with ESMTPS id 4D377120932 for ; Tue, 28 Jul 2020 04:22:23 +0900 (JST) Received: by filterdrecv-p3mdw1-75c584b9c6-dv7cm with SMTP id filterdrecv-p3mdw1-75c584b9c6-dv7cm-19-5F1F2988-5F 2020-07-27 19:22:48.709756336 +0000 UTC m=+2252046.925304489 Received: from herokuapp.com (unknown) by ismtpd0121p1mdw1.sendgrid.net (SG) with ESMTP id WoKPiQEMTzGeKOOGocNaRQ for ; Mon, 27 Jul 2020 19:22:48.594 +0000 (UTC) Date: Mon, 27 Jul 2020 19:22:48 +0000 (UTC) From: marcandre-ruby-core@marc-andre.ca Message-ID: References: Mime-Version: 1.0 X-Redmine-MailingListIntegration-Message-Ids: 75154 X-Redmine-Project: ruby-master X-Redmine-Issue-Tracker: Misc X-Redmine-Issue-Id: 17053 X-Redmine-Issue-Author: burdettelamar@yahoo.com X-Redmine-Sender: marcandre X-Mailer: Redmine X-Redmine-Host: bugs.ruby-lang.org X-Redmine-Site: Ruby Issue Tracking System X-Auto-Response-Suppress: All Auto-Submitted: auto-generated X-SG-EID: =?us-ascii?Q?6=2FIMxCQLDposcQf5wmbDAtfaKduBAO0bKyhL3BGZtMQ5q7K2TvpbN6A7JIyt9E?= =?us-ascii?Q?aOSVIAW2LufVrBCRP7mxXXxGiI=2FBWXCCwGlyHBX?= =?us-ascii?Q?VjwLqEZOeAsyEByVrL0yIw=2Fz5HGpPNu088Osau8?= =?us-ascii?Q?BYKhn0FoFEQ2oJoz0Y=2FVhBvIp613UtaGXhbqPJz?= =?us-ascii?Q?r5kmN4eCQWrC3v5=2FSNvZTo8z73k4ypV9vb3L0T+?= =?us-ascii?Q?qsyZGIHjSSS8SshLOFIQyLtWnNfAV1ftIlUoWg?= To: ruby-core@ruby-lang.org X-ML-Name: ruby-core X-Mail-Count: 99358 Subject: [ruby-core:99358] [Ruby master Misc#17053] RDoc for Hash Keys X-BeenThere: ruby-core@ruby-lang.org X-Mailman-Version: 2.1.15 Precedence: list Reply-To: Ruby developers List-Id: Ruby developers List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ruby-core-bounces@ruby-lang.org Sender: "ruby-core" Issue #17053 has been updated by marcandre (Marc-Andre Lafortune). burdettelamar@yahoo.com (Burdette Lamar) wrote: > My view has been this: This is API reference documentation. Ruby/ruby should have *the reference documentation*, and therefore should omit nothing. This is a very ambitious goal I'm not sure I share completely. Taking for example the documentation for `Hash`, one would need to talk about covariance of methods returning a hash (i.e. `Class.new(Hash).new.select{}.class` vs `Class.new(Hash).new.merge({}).class`), of treatment of a key `Float::NAN` (which is not `eql?` to itself), of recursive hashes, of the arity of enumerators (see https://bugs.ruby-lang.org/issues/14015#note-8 ), of the performance of hash lookup / insertion... All these details can not be repeated for each method, the same way we can't quote in full the floating point standard for `Float#+` and repeat it for `Float#-`, etc. On that subject, an example with `0.1 + 0.2` might be helpful though. ---------------------------------------- Misc #17053: RDoc for Hash Keys https://bugs.ruby-lang.org/issues/17053#change-86758 * Author: burdettelamar@yahoo.com (Burdette Lamar) * Status: Open * Priority: Normal ---------------------------------------- @marcandre writes, about the Hash Rdoc at https://docs.ruby-lang.org/en/master/Hash.html#class-Hash-label-Hash+Keys : > The only thing I would change is that I would shorten the doc on the "Invalid Hash Keys". As far as I know, this is simply not a important concern as nearly all Ruby objects respond_to? :hash and :eql? > I personally would recommend adding a single example in the Hash.html#class-Hash-label-Hash+Keys section and I would remove the rest, or at least remove the examples. They burden the reader with something that is of no use to them. I have misgivings: * Some of this material is very old, like the text and example for user-defined hash keys. * Some material I consolidated from earlier doc for individual methods, which now link to the relevant sections. * All is factual, and not repeated elsewhere in the page. My view has been this: This is API reference documentation. Ruby/ruby should have *the reference documentation*, and therefore should omit nothing. If material such as this is to be included, I see three possibilities: * Include in-line, as now. * Link to on-page 'footnote', with Back link. * Link to off-page rdoc, likely in doc/ dir. I'd love to hear some opinions on this. -- https://bugs.ruby-lang.org/