From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.devel Subject: Re: adding to emacs coding standard / formatting Date: Mon, 19 Oct 2020 09:28:45 +0000 Message-ID: References: <20201019031002.iulr45ztrkwsiqlo@E15-2016.optimum.net> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="33070"; mail-complaints-to="usenet@ciao.gmane.io" To: Boruch Baum , Emacs-Devel List Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Oct 19 11:29:24 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 1kURTo-0008WZ-BH for ged-emacs-devel@m.gmane-mx.org; Mon, 19 Oct 2020 11:29:24 +0200 Original-Received: from localhost ([::1]:50308 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kURTn-0005fv-C3 for ged-emacs-devel@m.gmane-mx.org; Mon, 19 Oct 2020 05:29:23 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:47380) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kURTF-0005Dy-SA for emacs-devel@gnu.org; Mon, 19 Oct 2020 05:28:49 -0400 Original-Received: from mail-ed1-x52e.google.com ([2a00:1450:4864:20::52e]:42810) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kURTE-0008RI-67 for emacs-devel@gnu.org; Mon, 19 Oct 2020 05:28:49 -0400 Original-Received: by mail-ed1-x52e.google.com with SMTP id v19so9469083edx.9 for ; Mon, 19 Oct 2020 02:28:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:in-reply-to:references:mime-version:date:message-id:subject:to; bh=1TBWo7WuZCdKO06kJMtIdeZtMwHSi94P6LqmRcAA8Fc=; b=M9TJhwUwGThkwJExupmVT+OO+gP4X/7JMlEtuw3xxJrVnuOZeXdPEJyiR3GWxfZObW 2S+IXAEF/8/0ATIIgrQisB2UktR3qnL+zDULpwCcStnfw1RCrAX4xdi5Wj4Cao7n2ngn Ff1tPoUMNOp/z/3u28Xvv20BDLlgbtNKtzbzNHo1O0vw3JAtxvpv/5+BPdyGCG9DZLGr 2CxYZlIpYRZCIoD91AIRSV3OyOpB4VNakXEYeW9weEXbJQ+RW7R1LWuk6vHCUwwkdFCS HL5c8fDTTnNl/+eazRZwW4JfQWM2WnXnRTtFfLT9xL98JZ4y7LRK+tW7JutQ83kvCssZ Pq3A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:in-reply-to:references:mime-version:date :message-id:subject:to; bh=1TBWo7WuZCdKO06kJMtIdeZtMwHSi94P6LqmRcAA8Fc=; b=Re63O0yEy8JuYtUy6xOkoP7203c58UOkDH+7D9HrE31ACjwpJGaWx6n0aWTSneeQn1 LVn/Eo1uGn6EA1fJjcGefk1AynJAmtCmPnYtDE54mueW0ToxZWFtZyD7lsfDrk3566jX 73ES1+1XANZGTYbVABcfxLA1OWDZc4q65AJdSB0R+hqmTS97D7FLYwHNvTqUnB377RGj H24hvR8jMUFsbR+/UEnDa6wy1cpwzz9F0LeFIpH/pMnUjoqQHfdtAx/bw1aartR8CHhk xYiyktOAzP8AcgCIAM3ZDxczGuWpBTDwwPu0GOKGULlDLqVQ4uu1gS9VHSNO1p/x2ISz UqqA== X-Gm-Message-State: AOAM5330GsGtGO4dActrgOaajEc/XHj2VbEflcnVwh1+DebpNvdjU4X6 i7pSgUivuRNux6Zp3ImLHJ43Lc2d3mCsMntw7lo= X-Google-Smtp-Source: ABdhPJyfyUrFA1WwkLXCPJUojLhdI+8/PNQp3I/yQ5fXGlQ8hPr98zCYPRWCf7tr22xHXypFXYXPxDUx2XE4ip/50bU= X-Received: by 2002:a50:b023:: with SMTP id i32mr16607544edd.377.1603099726279; Mon, 19 Oct 2020 02:28:46 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Mon, 19 Oct 2020 09:28:45 +0000 In-Reply-To: <20201019031002.iulr45ztrkwsiqlo@E15-2016.optimum.net> Received-SPF: pass client-ip=2a00:1450:4864:20::52e; envelope-from=stefankangas@gmail.com; helo=mail-ed1-x52e.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: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham 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:258102 Archived-At: Boruch Baum writes: > My work apropos the thread " ~Make emacs friendlier: package documentation [POC > CODE INCLUDED]" highlighted to me benefit to proposing to add to the > accepted / suggested / required format of emacs elisp packages. > > I had expecting symbol definitions to be grouped together by symbol type > and function, eg. all `defcustom's to be listed together in a section > beginning "^;;; Customization variables:", and so on for symbol > categories ";;; Global variables:", ";;; Buffer-local variables", ";;; > Internal functions:", ";;; Hook functions:", ";;; Interactive > functions:", etc. > > That isn't the case in package time.el, so that's probably also the case > in other packages. Should doing so be added to the coding standard? FWIW, I wouldn't like to see this added to our coding standards at a language level. I find it overly bureaucratic. Files should follow a standard that makes sense to what its trying to present. Also, third-party package developers should have some room to maintain their own standards. (That said, I'm not a fan of the organization in time.el, as it mixes unrelated things in one file and violates our prefix naming conventions.)