From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id qBa6LGtN52TKNwEASxT56A (envelope-from ) for ; Thu, 24 Aug 2023 14:30:35 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id AGg0LGtN52R3awAAauVa8A (envelope-from ) for ; Thu, 24 Aug 2023 14:30:35 +0200 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 4EEFE4D5EA for ; Thu, 24 Aug 2023 14:30:35 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20221208 header.b=M5EdmV78; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1692880235; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=Unv+IRav6zw5y9lnf1OiejLBUWn+4v0GvL+vUpJsPis=; b=uRmk2wmvpbSXPvZzcBi/FE66DKl++pUzdZlE5J5xvcqmYrnt/bMa8n2xpA2HMTuVIRcun4 cmLoDTeCxrZT1c+cslWkJRmtItMOIO4kqK1BgXX6mmb6hkkYx5KuDyccWfju1mHJaaKIYe tn4twWLW1PgPtIU6Va5NhhzEpdf48JvIK4TKEl32BjsYFpzGOxo+k1UTRS9R04vI3IzTWx CHNl0uQZsJg2YJ+sgFgOWAergVreG98FCE8bZ+JLsKqxF9rTLWLfI4vMKyRSeNKL1NmlBu MEYkgj6BCuvA36PGFt2LEv0GTaB5rcVKgYZD2DRrzTwSei78cHaZPbfAFhHVig== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1692880235; a=rsa-sha256; cv=none; b=QEmOMilACkhBSthM45ktvEBTVYKoatsfbtdqC+PJ4q6GJcwqMpoqMBO+OUgaJJFyHq6B// tAT6DyADwL773vvhHHiCXD43+wbGZ4wAnJ/bTQDsLzVi/g2K80ZqfGYTpIDkFKS4GZeR1/ MaAgpyveWmTjPGOsm7n7iSkuBavChOI5xsW3aBb+bLzpnyp7GLvlOZPo3e2mLRvXO/d5lg i1j+BH0xVduKzSDKvinDol9qIIOqDhlLEgJT7LuLy3SO7bCwOJyB2uLWi1A3OH8lKSBYZE YtBatnOOfos4+4I0H/H0t05A6OHoy+V4QRA9Kgerfmtci/FNJ2rB3Dj4+95ZSw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20221208 header.b=M5EdmV78; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gmail.com Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qZ9Sz-0008VQ-B7; Thu, 24 Aug 2023 08:29:37 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qZ9Sy-0008Uy-8P for emacs-orgmode@gnu.org; Thu, 24 Aug 2023 08:29:36 -0400 Received: from mail-qv1-xf2e.google.com ([2607:f8b0:4864:20::f2e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qZ9Sv-0000CR-9S for emacs-orgmode@gnu.org; Thu, 24 Aug 2023 08:29:36 -0400 Received: by mail-qv1-xf2e.google.com with SMTP id 6a1803df08f44-64b3ae681d1so33929906d6.0 for ; Thu, 24 Aug 2023 05:29:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1692880172; x=1693484972; h=mime-version:message-id:date:subject:to:from:user-agent:from:to:cc :subject:date:message-id:reply-to; bh=Unv+IRav6zw5y9lnf1OiejLBUWn+4v0GvL+vUpJsPis=; b=M5EdmV78A1JkbiQXcxKlsYtxRLT+CCdwdJu7Mb2tNgBJC9XW1x2aJkVUxMCi/7ghKf paMkfK15xJ8SxCdSAbR8DmpHPMmhuweqcBp8UPCDPD3qX0Z2ojKgX91uKCm/AxUFriFY Nnuome5lQH7LuxJBMYxR46sG57rddaP6HfPc6CUEy52YuHicKoIll52w0ADsQxnfLhKk 4wbshvnbQWPN0ET9CU9vKvuFe8OmGKnp49PHVidqECyi0yD3nHysrLBQCl+Fu0Zn/eBy qUUHg91H/EIBQC/j5gwnAFUSraS58z1k1i52dtDq1OWvQwdMyunOGSQAl0NxKUuetVmh f+EA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1692880172; x=1693484972; h=mime-version:message-id:date:subject:to:from:user-agent :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=Unv+IRav6zw5y9lnf1OiejLBUWn+4v0GvL+vUpJsPis=; b=Fejeu/9zpObzADiI7QPKXVjheVz1DXK9ZeTnFF1UfCt3g/vLoArGTs9lgUvCOPVWtL /MRjTywk1v2IcSjiheFHV5Pk8FoZHxQ0DDIZSlELhtb5XScBt5QeMvygUEO20HJ4ZeUa WZtarqv4odadE5DPli7/TxVX3AMcZZAXgm80iJnubNuEQA7BATpTOzWrqBg8yaUvi2zn TcQdf6YmwBIYZyTKdJ+UNIT/uYgR5bm0LBRkeJgWs4BbWfZUwO9HcVqQQc5nAekv0HZN oB4NlHBOqLQmTxIj7faQxj3WH3tTJTNSPy5onq6K1Ve+krzrvw7B2IAeRGXWX5q5+djD H3Ag== X-Gm-Message-State: AOJu0YweP++F+LCn3wxqkP6pjL/4UE5a7XukBC5TUOxg+GlvRblRlJwT JVPjmd2HvK1Rkr/cgUG0uhfjKzkkQSw= X-Google-Smtp-Source: AGHT+IExjEVjTRB84p3rwWZUPzmmbsiBc9rJxMC/XSLFBZ/Efaj9B1ltjaVpRDmF+b4bMgGeRt3XIw== X-Received: by 2002:a0c:e0cb:0:b0:63d:33f9:141 with SMTP id x11-20020a0ce0cb000000b0063d33f90141mr13040603qvk.34.1692880171764; Thu, 24 Aug 2023 05:29:31 -0700 (PDT) Received: from laptop ([2601:84:847f:c697:2d4:9eff:feb6:970c]) by smtp.gmail.com with ESMTPSA id t12-20020a0cde0c000000b006301d31e315sm2334721qvk.10.2023.08.24.05.29.30 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 24 Aug 2023 05:29:31 -0700 (PDT) User-agent: mu4e 1.11.15; emacs 30.0.50 From: No Wayman To: emacs-orgmode@gnu.org Subject: Org mode version 9.7-pre (9.7-pre-n/a-g63e8ca @ /home/n/.emacs.d/elpaca/builds/org/); [PATCH]: fix ob-lilypond docstrings Date: Thu, 24 Aug 2023 08:25:28 -0400 Message-ID: <87sf881v3z.fsf@gmail.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=2607:f8b0:4864:20::f2e; envelope-from=iarchivedmywholelife@gmail.com; helo=mail-qv1-xf2e.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.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -9.58 X-Spam-Score: -9.58 X-Migadu-Queue-Id: 4EEFE4D5EA X-Migadu-Scanner: mx1.migadu.com X-TUID: iPVLZtUiFXSc --=-=-= Content-Type: text/plain; format=flowed The attached patch satisfies all but two checkdoc warnings. I left those two for someone more familiar with the package. --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-lisp-ob-lilypond.el-satisfy-checkdoc.patch >From ecd5fe22458db64d86650a1a7a1e697d9ccff020 Mon Sep 17 00:00:00 2001 From: Nicholas Vollmer Date: Thu, 24 Aug 2023 08:20:22 -0400 Subject: [PATCH] * lisp/ob-lilypond.el: satisfy checkdoc (org-babel-lilypond-compile-post-tangle): fix docstring (org-babel-lilypond-display-pdf-post-tangle): fix docstring (org-babel-lilypond-play-midi-post-tangle): fix docstring (org-babel-execute:lilypond): fix docstring (org-babel-lilypond-tangle): fix docstring (org-babel-lilypond-process-basic): fix docstring (org-babel-lilypond-parse-line-num): fix docstring (org-babel-lilypond-set-header-args): fix docstring --- lisp/ob-lilypond.el | 37 ++++++++++++------------------------- 1 file changed, 12 insertions(+), 25 deletions(-) diff --git a/lisp/ob-lilypond.el b/lisp/ob-lilypond.el index 8b2bd231f..47ad0a25d 100644 --- a/lisp/ob-lilypond.el +++ b/lisp/ob-lilypond.el @@ -58,23 +58,13 @@ ob-lilypond-header-args See `org-babel-lilypond-set-header-args'.") (defvar org-babel-lilypond-compile-post-tangle t - "Following the org-babel-tangle (C-c C-v t) command, -org-babel-lilypond-compile-post-tangle determines whether ob-lilypond should -automatically attempt to compile the resultant tangled file. -If the value is nil, no automated compilation takes place. -Default value is t.") + "When non-nil, compile tangled file after `org-babel-tangle'.") (defvar org-babel-lilypond-display-pdf-post-tangle t - "Following a successful LilyPond compilation -org-babel-lilypond-display-pdf-post-tangle determines whether to automate the -drawing / redrawing of the resultant pdf. If the value is nil, -the pdf is not automatically redrawn. Default value is t.") + "When non-nil, display pdf after successful LilyPond compilation.") (defvar org-babel-lilypond-play-midi-post-tangle t - "Following a successful LilyPond compilation -org-babel-lilypond-play-midi-post-tangle determines whether to automate the -playing of the resultant midi file. If the value is nil, -the midi file is not automatically played. Default value is t") + "When non-nil, play midi file after successful LilyPond compilation.") (defvar org-babel-lilypond-ly-command "" "Command to execute lilypond on your system. @@ -155,20 +145,17 @@ org-babel-expand-body:lilypond body)) (defun org-babel-execute:lilypond (body params) - "This function is called by `org-babel-execute-src-block'. -Depending on whether we are in arrange mode either: -1. Attempt to execute lilypond block according to header settings - (This is the default basic mode) -2. Tangle all lilypond blocks and process the result (arrange mode)" + "Execute lilypond src blcok according to arragne mode. +See `org-babel-execute-src-block' for BODY and PARAMS. +When in arrange mode, tangle all blocks and process the result. +Otherwise, execute block according to header settings." (org-babel-lilypond-set-header-args org-babel-lilypond-arrange-mode) (if org-babel-lilypond-arrange-mode (org-babel-lilypond-tangle) (org-babel-lilypond-process-basic body params))) (defun org-babel-lilypond-tangle () - "ob-lilypond specific tangle, attempts to invoke -=ly-execute-tangled-ly= if tangle is successful. Also passes -specific arguments to =org-babel-tangle=." + "Tangle lilypond blocks, then `org-babel-liypond-execute-tangled-ly'." (interactive) (if (org-babel-tangle nil "yes" "lilypond") (org-babel-lilypond-execute-tangled-ly) nil)) @@ -190,7 +177,8 @@ org-babel-lilypond-paper-settings They are needed for mixing music and text in basic-mode.") (defun org-babel-lilypond-process-basic (body params) - "Execute a lilypond block in basic mode." + "Execute a lilypond block in basic mode. +See `org-babel-execute-src-block' for BODY and PARAMS." (let* ((out-file (cdr (assq :file params))) (file-type (file-name-extension out-file)) (cmdline (or (cdr (assq :cmdline params)) @@ -308,7 +296,7 @@ org-babel-lilypond-mark-error-line (goto-char temp)))) (defun org-babel-lilypond-parse-line-num (&optional buffer) - "Extract error line number." + "Extract error line number in BUFFER or `current-buffer'." (when buffer (set-buffer buffer)) (let ((start (and (search-backward ":" nil t) @@ -441,8 +429,7 @@ org-babel-lilypond-get-header-args ob-lilypond-header-args))) (defun org-babel-lilypond-set-header-args (mode) - "Set org-babel-default-header-args:lilypond -dependent on ORG-BABEL-LILYPOND-ARRANGE-MODE." + "Set lilypond babel header args from ORG-BABEL-LILYPOND-ARRANGE-MODE." (setq org-babel-default-header-args:lilypond (org-babel-lilypond-get-header-args mode))) -- 2.41.0 --=-=-=--