From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id sL9DMzZyWGHPHgEAgWs5BA (envelope-from ) for ; Sat, 02 Oct 2021 16:52:38 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id XG/nLjZyWGFXBQAA1q6Kng (envelope-from ) for ; Sat, 02 Oct 2021 14:52:38 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id D3667310E0 for ; Sat, 2 Oct 2021 16:52:37 +0200 (CEST) Received: from localhost ([::1]:56412 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mWgNN-0003pg-2D for larch@yhetil.org; Sat, 02 Oct 2021 10:52:36 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50646) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mWgMd-0003md-Vj for emacs-orgmode@gnu.org; Sat, 02 Oct 2021 10:51:51 -0400 Received: from mail-qk1-x736.google.com ([2607:f8b0:4864:20::736]:39799) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mWgMc-0002Vt-DV; Sat, 02 Oct 2021 10:51:47 -0400 Received: by mail-qk1-x736.google.com with SMTP id f130so12104098qke.6; Sat, 02 Oct 2021 07:51:45 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=references:user-agent:from:to:cc:subject:date:in-reply-to :message-id:mime-version; bh=uVoRRqMcLMR6MOe+UO71nq1oPyoBU8ekHekhZ8Cw3TQ=; b=HQCzsrHOEXWxgp33A2eamjL8OZ14qS2HnQxHgxemApzX05hwU5s54BB6d4Ocm+jTAx wqKNUZR1T5fgc1zovxa+z28e2PAqOgLwTdc+H62fkmdJpI45z5OhB7y1z/jsVJkcDsvf sY5v+HcKtsP+5mMXfAzy/RGflTjqEhC4MiQEZBtaswsS7HqGpa+9Zk9qxHdoZwgk49uv J7p/Q6qKbghEG/H4yjmJXeIaLpbU9UIgiVf5KGcBlSXgsmB7aw82XYBWlQYX5jQ5b5Sg 8AG88EGfBhIcjRMnAKUYyiNoh/nltsQ4jYA8Sb698eQ7tZwbWRiPfC6OCKT/IinsYHbh MoyA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:references:user-agent:from:to:cc:subject:date :in-reply-to:message-id:mime-version; bh=uVoRRqMcLMR6MOe+UO71nq1oPyoBU8ekHekhZ8Cw3TQ=; b=VHT+HpgbdsQneg27zaHODz4GdGzBsTKxnvBY9foxeMMF0PwBU+4jp7m5lia8KmXSBw xdHAnuSXswZMlQDC0LeKmIFi7J74a0NX6PmybsSmM91F+ZW2wo8suU6VWpoTJiFhQ7fH S4lPq27Ef5PVOviX1mfAV/DBtE+NAbwonQxEElB1S0ZXJlAZA+NLW0QAtPt/1Euo2U8G g9PQ9HjDxOg6XVzFBUorRXvwsjRQ9IYlLn/7HcvJHOf9w5IeX3LCFxuQatz1lR+nwxXV BUAY7Wj+NN8rVR/XM6wjL6O/GYJO2hZdwUd/RPp/tAoiF6xs/n6VY0lAEUdQkUYFH9bg j8TA== X-Gm-Message-State: AOAM53173HRN0Kh57LrTqMWaBVbufK76ajcNwNF97cKypYHWh2luodj3 ritvorB/xUW2wsj1Y5LzEe8HZQAoWJ4= X-Google-Smtp-Source: ABdhPJxgZxpGtjB7bdIi6xZsiMQWd3XLVS+lR2fIpKQGTe7eN/lEPtnToytCL4DLolXemCmBmvXPpw== X-Received: by 2002:a37:b386:: with SMTP id c128mr2809578qkf.426.1633186304766; Sat, 02 Oct 2021 07:51:44 -0700 (PDT) Received: from arch ([2601:82:c200:166d:afae:ebe6:a0e2:409e]) by smtp.gmail.com with ESMTPSA id p17sm6129109qtl.52.2021.10.02.07.51.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 02 Oct 2021 07:51:44 -0700 (PDT) References: <87h7e1kebb.fsf@gmail.com> <87fstkoxfs.fsf@gnu.org> <87zgrrv7fi.fsf@gmail.com> <87v92f7al0.fsf@gnu.org> User-agent: mu4e 1.7.0; emacs 28.0.50 From: No Wayman To: Bastien Subject: Re: [BUG] [PATCH] org-src.el: Fix checkdoc warnings [9.5 (9.5-g59cb39 @ /home/n/.emacs.d/straight/build/org/)] Date: Sat, 02 Oct 2021 10:49:51 -0400 In-reply-to: <87v92f7al0.fsf@gnu.org> Message-ID: <874k9za39c.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=2607:f8b0:4864:20::736; envelope-from=iarchivedmywholelife@gmail.com; helo=mail-qk1-x736.google.com 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-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: emacs-orgmode@gnu.org Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1633186358; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=uVoRRqMcLMR6MOe+UO71nq1oPyoBU8ekHekhZ8Cw3TQ=; b=qTyF/qDLaflNxO29jF95/L+JP6OZLOtJmIgvWPkm1+VhmqFPj59LRM1tv8gXNWnNSHDdg0 /yTfM844xgHJg0/+LhuccuGMSpw2ZlBpMZscRis2IsQGP/KrnG9oRUn68YYgSdWR+1IIf/ UnfgBni85i3OBO+fqF4pq+Ickz9Rfr0nnoBYupoT42iVf+217LZiuq97zLB/X8XmIijvRM IxCXZSWVH0rWAYH4P0Hv1+VdJR9W3vYY6ggaDE1yhjHnrdM9FMRWUX/V2yxYsd8vlM7r3i K6MXOIAr+mr9gDMwiElw+MmFeX3FynK4R03gQCLQK1ZgXkUJGaQkUCBM2kqxDw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1633186358; a=rsa-sha256; cv=none; b=GkEypHT0Qpsag2Pi84MHkIxTiwTzecSPIzPp1IsrVOUIKIoUtOxVoCFYNCCZ23e4xmBFzG iaevSBfgYT6oS0vxZKNLumV27kqKNwBpXXUrzmrT6eM5mF0fdFrpAKvRj8WyoocdUbEf8Q 75u3FN4f4nTmb3H+GvUpxEIsQddXc8FnkNlqZq3K19zwc59+QypaGDqyZOJio5ywi+tnaC dNZ04YtKZolaZvhFk9/HbyXa2M69KPohm7p0w4W9U4YAYW43v/TCYLGL0BOwR1Pr0XlHjF s0wnc2B8FpXT28+VwFs4+ADLdVl/JXaAGfTqqBsf4fwdpRZOpeZBd0UInh2qfQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=HQCzsrHO; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -3.10 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=HQCzsrHO; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: D3667310E0 X-Spam-Score: -3.10 X-Migadu-Scanner: scn0.migadu.com X-TUID: ZHQC36ryqZ5w --=-=-= Content-Type: text/plain; format=flowed Bastien writes: > Thanks -- it does not apply against the main branch, can you > rebase > and resend it? Certainly. See attached. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-org-src.el-Fix-checkdoc-warnings.patch >From 4971ceb26a1fb138f4eeddc1a569b5c4dd3f1859 Mon Sep 17 00:00:00 2001 From: Nicholas Vollmer Date: Thu, 30 Sep 2021 16:07:15 -0400 Subject: [PATCH] org-src.el: Fix checkdoc warnings * org-src.el: Fix checkdoc warnings. --- lisp/org-src.el | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/lisp/org-src.el b/lisp/org-src.el index 8d02cf434..23e196438 100644 --- a/lisp/org-src.el +++ b/lisp/org-src.el @@ -37,6 +37,7 @@ (require 'org-compat) (require 'org-keys) +(declare-function org--get-expected-indentation "org" (element contentsp)) (declare-function org-mode "org" ()) (declare-function org--get-expected-indentation "org" (element contentsp)) (declare-function org-element-at-point "org-element" ()) @@ -240,8 +241,7 @@ green, respectability. :package-version '(Org . "9.0")) (defcustom org-src-tab-acts-natively t - "If non-nil, the effect of TAB in a code block is as if it were -issued in the language major mode buffer." + "If non-nil, TAB uses the language's major-mode binding in code blocks." :type 'boolean :package-version '(Org . "9.4") :group 'org-babel) @@ -304,7 +304,8 @@ is 0.") (put 'org-src--preserve-blank-line 'permanent-local t) (defun org-src--construct-edit-buffer-name (org-buffer-name lang) - "Construct the buffer name for a source editing buffer." + "Construct the buffer name for a source editing buffer. +Format is \"*Org Src ORG-BUFFER-NAME [ LANG ]*\"." (concat "*Org Src " org-buffer-name "[ " lang " ]*")) (defun org-src--edit-buffer (beg end) @@ -614,7 +615,7 @@ Leave point in edit buffer." ;;; Fontification of source blocks (defun org-src-font-lock-fontify-block (lang start end) - "Fontify code block. + "Fontify code block between START and END using LANG's syntax. This function is called by Emacs' automatic fontification, as long as `org-src-fontify-natively' is non-nil." (let ((lang-mode (org-src-get-lang-mode lang))) @@ -760,7 +761,9 @@ See also `org-src-mode-hook'." ;;; Babel related functions (defun org-src-associate-babel-session (info) - "Associate edit buffer with comint session." + "Associate edit buffer with comint session. +INFO should be a list simlar in format to the return value of +`org-babel-get-src-block-info'." (interactive) (let ((session (cdr (assq :session (nth 2 info))))) (and session (not (string= session "none")) @@ -770,6 +773,7 @@ See also `org-src-mode-hook'." (and (fboundp f) (funcall f session)))))) (defun org-src-babel-configure-edit-buffer () + "Configure src editing buffer." (when org-src--babel-info (org-src-associate-babel-session org-src--babel-info))) @@ -842,6 +846,7 @@ Raise an error when current buffer is not a source editing buffer." org-src--source-type) (defun org-src-switch-to-buffer (buffer context) + "Switch to BUFFER considering CONTEXT and `org-src-window-setup'." (pcase org-src-window-setup (`plain (when (eq context 'exit) (quit-restore-window)) @@ -1204,11 +1209,12 @@ the area in the Org mode buffer." (interactive) (let (org-src--allow-write-back) (org-edit-src-exit))) -(defun org-edit-src-continue (e) +(defun org-edit-src-continue (event) "Unconditionally return to buffer editing area under point. -Throw an error if there is no such buffer." +Throw an error if there is no such buffer. +EVENT is passed to `mouse-set-point'." (interactive "e") - (mouse-set-point e) + (mouse-set-point event) (let ((buf (get-char-property (point) 'edit-buffer))) (if buf (org-src-switch-to-buffer buf 'continue) (user-error "No sub-editing buffer for area at point")))) -- 2.33.0 --=-=-=--