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=-2.5 required=3.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, FORGED_YAHOO_RCVD,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, 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 94E7A1F5AE for ; Mon, 27 Jul 2020 17:55:12 +0000 (UTC) Received: from neon.ruby-lang.org (localhost [IPv6:::1]) by neon.ruby-lang.org (Postfix) with ESMTP id 27E1F12098A; Tue, 28 Jul 2020 02:54:40 +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 14088120937 for ; Tue, 28 Jul 2020 02:54:37 +0900 (JST) Received: by filterdrecv-p3iad2-5b55dcd864-m99xc with SMTP id filterdrecv-p3iad2-5b55dcd864-m99xc-18-5F1F14F7-9C 2020-07-27 17:55:03.811697856 +0000 UTC m=+2681138.416646123 Received: from herokuapp.com (unknown) by ismtpd0078p1mdw1.sendgrid.net (SG) with ESMTP id PsvXxyjRS7qkTWxBmHosQg for ; Mon, 27 Jul 2020 17:55:03.698 +0000 (UTC) Date: Mon, 27 Jul 2020 17:55:03 +0000 (UTC) From: burdettelamar@yahoo.com Message-ID: References: Mime-Version: 1.0 X-Redmine-MailingListIntegration-Message-Ids: 75150 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: burdettelamar@yahoo.com 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?M0WX68AHQr=2FVSnvsB1Qo5xEo9+xKABJC=2FqJZ83MVt=2FraJrj2tho6+adjy0ZOBm?= =?us-ascii?Q?l9DVhyWRSMPdoBCgBslkhyluMEEmaG4LUPv10jl?= =?us-ascii?Q?jH1dVXYvmbV0EDl1hg1BPCZdtzj2xeoVS+lX5uJ?= =?us-ascii?Q?3fwt8CCccj7kFistZa8Iy7+6CdxrhoFs+lzoxj+?= =?us-ascii?Q?oj2RhvCY16+WeWJTGGfOIanTMiMuj8gQTu8OkOX?= =?us-ascii?Q?xvuNyY2kzo0E3tPdw=3D?= To: ruby-core@ruby-lang.org X-ML-Name: ruby-core X-Mail-Count: 99356 Subject: [ruby-core:99356] [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 burdettelamar@yahoo.com (Burdette Lamar). Should have linked to the source of the remarks: https://github.com/ruby/ruby/pull/3139#issuecomment-663281047 ---------------------------------------- Misc #17053: RDoc for Hash Keys https://bugs.ruby-lang.org/issues/17053#change-86754 * 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/