From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Joseph Turner Newsgroups: gmane.emacs.devel Subject: Re: [NonGNU ELPA] New package org-transclusion-http Date: Sat, 15 Jun 2024 14:08:43 -0700 Message-ID: <87ed8xoqw4.fsf@ushin.org> References: <87sezvt2rc.fsf@ushin.org> <87tti2u8jx.fsf@ushin.org> <87o782mje9.fsf@posteo.net> <87ikyaniwl.fsf@ushin.org> <878qz6kog3.fsf@posteo.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="29779"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Emacs Devel Mailing List , me@nobiot.com To: Philip Kaludercic Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Jun 16 07:11:43 2024 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 1sIiB4-0007XN-Ha for ged-emacs-devel@m.gmane-mx.org; Sun, 16 Jun 2024 07:11:43 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sIiAP-0007SN-1p; Sun, 16 Jun 2024 01:11:01 -0400 Original-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 1sIadx-0004Tw-Sz for emacs-devel@gnu.org; Sat, 15 Jun 2024 17:09:01 -0400 Original-Received: from out-189.mta0.migadu.com ([2001:41d0:1004:224b::bd]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sIadq-0005Sz-RA for emacs-devel@gnu.org; Sat, 15 Jun 2024 17:08:57 -0400 X-Envelope-To: philipk@posteo.net DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ushin.org; s=key1; t=1718485729; h=from:from: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; bh=/oQ+alNNDb7nz3zP0auMxbJFnWP6BcAPBazYuoT6dT8=; b=j/BVirtKzIgb6OjlYFAK/JglS3bZTOfsHlgW5xwm9aAe36q+8N/2pv128GbWfopOc1CQHN l8Tzi45NM6u/919R61+9jffqjbl6J+KkrQodpwP6bXZ2+YWzTLLNKo4uA8ee82FpT+RWy/ +qL0tu1SfoL+GcSf1h9UWpka8386laoyB+A9UQehI6JfLWHv/RQNQU/WXYW14L+eYo9ovH ahutC/EtMnBCYJuwv00riMqErgWHHBzFdLljt2YKYCJwna+YxSwjJFSY9HhydBdoUeABFm EkkJ1eFqo0sCR6VYizrD6ulCBool2tcZm1cH5dKpKFLhI/JwwwyOXDZZ4FUajg== X-Envelope-To: emacs-devel@gnu.org X-Envelope-To: me@nobiot.com X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. In-Reply-To: <878qz6kog3.fsf@posteo.net> (Philip Kaludercic's message of "Sat, 15 Jun 2024 19:15:08 +0000") X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:1004:224b::bd; envelope-from=joseph@ushin.org; helo=out-189.mta0.migadu.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, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Sun, 16 Jun 2024 01:10:58 -0400 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 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-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:320174 Archived-At: Philip Kaludercic writes: > Joseph Turner writes: > >> Thank you for the review! >> >> Philip Kaludercic writes: >> >>> There is really not much I can comment on, since it is mainly API I am >>> not familiar with. One note is that the package description doesn't >>> make much sense to me, since I don't know what "transcluding" means. >>> Also, not everyone knows that "plz" is a HTTP library (the name remains >>> elusive), so a brief comment reminding the reader of that would be >>> appropriate. >> >> I've updated the package description. > > This is the commit you are referring to? > > diff --git a/org-transclusion-http.el b/org-transclusion-http.el > index 5f240ad31c..293e705615 100644 > --- a/org-transclusion-http.el > +++ b/org-transclusion-http.el > @@ -25,8 +25,8 @@ > > ;;; Commentary: > > -;; This file contains functionality related to transcluding content over HTTP > -;; using plz.el. Features include: > +;; This file extends the `org-transclusion' package to allow for transcluding > +;; content over HTTP. Features include: > ;; > ;; - Transclude plain text > ;; + Transclude only Org headings matching search options > > I don't know if this is just me, but I am not familiar with what > "transcluding" is supposed to mean. I get that it has something to do > with networking, and if I had to guess you are fetching remote files and > including them while exporting, but a package description shouldn't > leave the reader with the impression that they have to guess what is > going on. Transclusion is the inclusion of part or all of an electronic document into one or more other documents by reference via hypertext: https://en.wikipedia.org/wiki/Transclusion Since this package is just a minor extension of the org-transclusion package, I think it's fine to direct users to learn more by reading the package description for org-transclusion. If there's a specific specific phrase you'd like to add, I'll be happy to apply a patch. >>> Another note is that if you already have a .dir-locals.el file, you >>> could add a few more variables that might vary from system to system. >>> In Compat, the .dir-locals.el lists: >>> >>> --8<---------------cut here---------------start------------->8--- >>> ((nil >>> (fill-column . 72) >>> (sentence-end-double-space . t) >>> (show-trailing-whitespace . t) >>> (indent-tabs-mode . nil))) >>> --8<---------------cut here---------------end--------------->8--- >> >> I've added all these variables except show-trailing-whitespace, as I >> don't personally use it. ws-butler takes care of whitespace without >> adding visuals. > > No problem, I like `show-trailing-whitespace' because I know that all > contributors will see that there is a whitespacing issue, but I admit > that my recommendations might be opinionated. Sounds good! Thanks! Joseph