From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Dmitry Gutov Newsgroups: gmane.emacs.devel Subject: Re: Opaque objects and Emacs documentation Date: Fri, 17 Jul 2020 16:13:33 +0300 Message-ID: <57619ed5-49d5-d2a5-f205-8ea722d7f703@yandex.ru> References: <20200712184908.13140.5739@vcs0.savannah.gnu.org> <20200712184909.BBC61209B1@vcs0.savannah.gnu.org> <7bf4d6ef-c0ec-43dc-ad5d-f6e81422ad90@yandex.ru> <83zh84m5ws.fsf@gnu.org> <3dd1c224-69b2-40af-5b2e-43a310253632@yandex.ru> <83tuybmtxs.fsf@gnu.org> <859f594b-1343-6d26-e1ac-7157c44eb56c@yandex.ru> <83a6zyk4tt.fsf@gnu.org> <6edffb7d-7708-534f-93ad-bf9180f5e0ed@yandex.ru> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="17274"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.10.0 To: emacs-devel@gnu.org, Gregory Heytings Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri Jul 17 15:14:25 2020 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1jwQBu-0004FA-A2 for ged-emacs-devel@m.gmane-mx.org; Fri, 17 Jul 2020 15:14:18 +0200 Original-Received: from localhost ([::1]:43144 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jwQBt-0004F4-A2 for ged-emacs-devel@m.gmane-mx.org; Fri, 17 Jul 2020 09:14:17 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:57856) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jwQBG-0003NH-EY for emacs-devel@gnu.org; Fri, 17 Jul 2020 09:13:38 -0400 Original-Received: from mail-wm1-x32a.google.com ([2a00:1450:4864:20::32a]:51922) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jwQBE-0003Gv-MZ for emacs-devel@gnu.org; Fri, 17 Jul 2020 09:13:38 -0400 Original-Received: by mail-wm1-x32a.google.com with SMTP id 22so14746291wmg.1 for ; Fri, 17 Jul 2020 06:13:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=Kna+kiyuXBnRx/CxRhSQdtCykv1UVk5/lRpbOefs+/k=; b=QKmRWFJNqK2+lZuhSs85vjoiNnKPguvFIyHbs3yTWYemTp2Oj6f6TwxCtL+c6YxfaO Qmk68zs040flbQTjyN5d4EF1q344Etc3D/OK5q7QmL/NC8IBYI2SDtJ3QKpYAsd9P6lk WwQM/hHpCW5HcYE0HPkZxc7EZBPoeXNBUnMlhVFORrCi4jDjkVoeRLjee93lXd5OFtgy htvV2ldusBC9rSGjtKHRlTPuu2QDs4jgSs9dkdmKu2M0nBJboxG5bqrJc2EOBCFE321c 1XE5z8awpLkpmgA0fhd6PPKsl1WhIKuEeoEXbs/7zmQWMrBJf1BP+0wfBGhflrChDgSE UNcg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=Kna+kiyuXBnRx/CxRhSQdtCykv1UVk5/lRpbOefs+/k=; b=GYyg8nltCUSxOy6L2olz4O9s3qNG/Xmmv8PxGGnODTu93S/bJG8Ct/k1VHY8nPxF+p /fVwUhBg9kqmEcje3gFn5HLL7nsFGN42SPwL7jKAQxkgpRDr8GiaWZnarrpNea6lyjki JSzFO6Or39GyeT8OMNDfYh6tyfTz/EdwZAQiw6vcZpMrDSSDqiRKJK4clzriIsePa2lu Cmd5Qa0Wj4CIc5syk1QVehs3w+uQW0TtRDrCRV3fXIxK9iegapHW7gOdN75d0+2Xs+T+ I/CjpAuj7uTb42F+5ctfqK2xFIdemfU78OmNqZMtv+khJ7JjL1FH4VHMV46NhJpMqJWl NBtA== X-Gm-Message-State: AOAM530QfuuzD36V6wnom1dYVK02TWlpk4bEYTtl+II8tKw6Peq7BMnH 3hHr9QtAuWF70NhsdXFPShSYwKhR X-Google-Smtp-Source: ABdhPJx/e/WqgtNcpPNhwm/FClMwb1bvvfmZCBrxUfVTbc65wfWeR7EuGYhrUGLliGLgBOwAUWoi0Q== X-Received: by 2002:a1c:4987:: with SMTP id w129mr9206576wma.9.1594991615059; Fri, 17 Jul 2020 06:13:35 -0700 (PDT) Original-Received: from [192.168.0.6] ([109.110.245.170]) by smtp.googlemail.com with ESMTPSA id j145sm14562818wmj.7.2020.07.17.06.13.34 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 17 Jul 2020 06:13:34 -0700 (PDT) In-Reply-To: Content-Language: en-US Received-SPF: pass client-ip=2a00:1450:4864:20::32a; envelope-from=raaahh@gmail.com; helo=mail-wm1-x32a.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: 0 X-Spam_score: 0.0 X-Spam_bar: / X-Spam_report: (0.0 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FORGED_FROMDOMAIN=1, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:253016 Archived-At: On 17.07.2020 14:53, Gregory Heytings via Emacs development discussions. wrote: > IMO the main goal of writing Emacs documentation (and software > documentation in general) is not to help its users, but to help all > those who in the future, when you will have moved to something else, > will work on the code you wrote. So you have never encountered a difference between internal documentation and public documentation? > For them it is definitely very useful > to understand the implementation choices you made, the internal > representations you chose to use, and so forth.  In fact, such a > documentation is probably also useful for yourself, if you leave your > code temporarily, and come back to it after a while. Even coming back to it in a few years, I'm pretty sure I can spare several seconds to call project-try-vc and see which value it returns. The most valuable documentation is not this kind: // add 1 to x x += 1 but that which describes original choices, and the reasons for them. Or an overview of how the system works. We're not discussing either of those options here.