From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.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 aFlYCacJ92RkPgEA9RJhRA:P1 (envelope-from ) for ; Tue, 05 Sep 2023 12:57:43 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id aFlYCacJ92RkPgEA9RJhRA (envelope-from ) for ; Tue, 05 Sep 2023 12:57:43 +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 D8DB544511 for ; Tue, 5 Sep 2023 12:57:42 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=BtpqzDTQ; 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=posteo.net ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1693911463; 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=bHESQFtY8VVCcLnLarUz3FeQxZs2YbGJFVV2pSNXKpw=; b=TbacpnEf6Mp/G1ifA2csHVORPrLkw2weJayKszROS0StrDxX+OryRfrRbbZi2wMPPIsqE3 G98USbHE1w+I0bPxU9J54FaZdjHiRCEsWiPzpXDde+in2FD+0nu1Jqj0dururyuwiILUZX 3rCXImo/yiPOG8OxOx7HnW06ow8LQ4V5F5RPVMNUPnNYgW4ls68Mr9Rrh7xX7bx7BDCpIA 53VSiRijBFLbm2sUYtLJhjfkz5XHgdGb551yRXhO3njq6SO2ILCQUZ04TkeMYuCDTnGAVt HA7LqFQlDIwtsVfTI14lOJrvr+TeuRVRJxTTV7jLyWqyypQXvbqoQRh9NBYe3w== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=BtpqzDTQ; 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=posteo.net ARC-Seal: i=1; s=key1; d=yhetil.org; t=1693911463; a=rsa-sha256; cv=none; b=p0OH2Em54/7NF2Fbi9HC1OKGqlK3s4xXRvYxzMN8IsCLjheIa/Y3h1pg+QXN9iHER7VXqh +uVUo6fX+MA8sceoVpgdaj2sykwF14nDsuH9aCaNHmIcXwjYwDIyPgu1HXiIZn9PLKZGFC qU8LB5MhmhGiwXgkju5JTFaIO02sLLax5mnhDlGWVhS1bN0bXSh9lcimM+/hyl4nE/rbEO uGUogzbPRGJi/6FveomGn4b+YfV6yndsjSz+MZeZiNDbEdfOiifXouD/gnUMfc2lSXfIqC 4FUEz6dV+95R36ZPSIgUxNwxHdLkO/lsz5p/NVmMc4ou+xsOgzMKOtpku5gxpQ== Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qdTjk-0003Rz-78; Tue, 05 Sep 2023 06:56:48 -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 1qdTjh-0003R4-49 for emacs-orgmode@gnu.org; Tue, 05 Sep 2023 06:56:45 -0400 Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qdTje-0007gN-B5 for emacs-orgmode@gnu.org; Tue, 05 Sep 2023 06:56:44 -0400 Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 1EED1240101 for ; Tue, 5 Sep 2023 12:56:39 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1693911399; bh=rIORdVKuIFxaaE+rR2CCoNvcx4p34Oeri8VHnXmvcmM=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:From; b=BtpqzDTQzKTOyHIItKR02wngeiIjc6cWrr+LLeZEvqRTDAdoAp92aL7+LpK4H65T9 qMLtWD7Zh6NLcRDviRhig6lDK6gQawUkrfGQR8AeqRVZOXT33CIvrcAh055Z9IrVLM uAXQRGp2KYHL1WMvKyZn1SJQwy5bUX7MLMq8QoW0mFGj30PzFVZZmLj8eiZVACH/pJ c/3AP4Kuo7RlS37DBXfZ39tGcN2uuk1C1eZyt8CHY0aJh/NvAmTm76FoGUtBY5i2LX WG/U1VuR7eLHfkreI6JmT7iDryCKCBc9UHnXdxoT+zWuj67xgrgZ09Q3ew9MwuhNHc K9kkBfoT6nWMQ== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Rg2WB2fKQz6txj; Tue, 5 Sep 2023 12:56:38 +0200 (CEST) From: Ihor Radchenko To: Leo Butler , Bastien Cc: Lockywolf , "emacs-orgmode@gnu.org" Subject: [MAINTENANCE] On how much we can expose internals into defcustom (was: [BUG] Consider replacing bachload with batch in ob-maxima. [9.6.6 (release_9.6.6 @ /usr/share/emacs/30.0.50/lisp/org/)]) In-Reply-To: <87wmx8h2b0.fsf@t14.reltub.ca> References: <874jkemrk2.fsf@laptop.lockywolf.net> <87cyz1ivzw.fsf@t14.reltub.ca> <874jkdhwix.fsf@localhost> <87wmx8h2b0.fsf@t14.reltub.ca> Date: Tue, 05 Sep 2023 10:57:27 +0000 Message-ID: <87il8ovqeg.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=185.67.36.66; envelope-from=yantar92@posteo.net; helo=mout02.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=unavailable 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-Queue-Id: D8DB544511 X-Migadu-Scanner: mx1.migadu.com X-Migadu-Spam-Score: -6.46 X-Spam-Score: -6.46 X-TUID: 1+nny/p6jBgD CCing Bastien, as he might want to intervene. Leo Butler writes: >> +(defcustom org-babel-maxima-command-arguments >> + "--very-quiet" > >> +(defcustom org-babel-maxima-batch/load >> + "batchload" >> + >> +(defcustom org-babel-maxima-graphic-file-format-string >> + "(set_plot_option ('[gnuplot_term, png]), set_plot_option ('[gnuplot_out_file, %S]))$" >> + >> +(defcustom org-babel-maxima-default-epilogue >> + "gnuplot_close ()$" >> IMHO, in their current state, if a user mindlessly customizes these >> options without knowing how ob-maxima internals work, ob-maxima may >> simply be broken. > > I think there is a fine line between being too rigid but working within > a limited scope (as ob-maxima is now), or providing enough customizable > options to let users do what they want. I would prefer the latter, > if the defaults provide a working configuration. > > Note that I do attempt to suggest other working options in the defcustom > definitions. >> As a general rule, we do not expose internal details that are _required_ >> for things to work to users. > > I understand this principle, but, why not provide enough options for > users to configure a package to do what they want? Yes, that may mean > they break the package--but only temporarily, because returning to the > default options will return the package to a working state. That's a bit more tricky. Imagine, for example, that we commit +(defcustom org-babel-maxima-command-arguments + "--very-quiet" and some users will later customize the default value to "--very-quite --my-personal-switch-I-want" Then, in future, due to changes in Org or maxima, we might need to change "--very-quite" to something else in order to keep ob-maxima in working condition: "--very-quite=yes --another-useful-flag-we-absolutely-need-in-org" In order to make such a switch, we will have to force all the users change their customization - something we do not want to annoy users with. So, leaving essential settings customizeable is not necessarily a good idea. This is not necessarily a rigid rule though - we do leave, for example, `org-latex-engraved-preamble' exposed to the users in ways that can break LaTeX src block export. The basic condition is that changing something should be practically useful for users, which is why I asked you to elaborate on why each of the new customizations need to be introduced. -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at