From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:306:2d92::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id WHsHEUEtqWQM8QAASxT56A (envelope-from ) for ; Sat, 08 Jul 2023 11:32:49 +0200 Received: from aspmx1.migadu.com ([2001:41d0:306:2d92::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id aBKiEEEtqWSKBwAAauVa8A (envelope-from ) for ; Sat, 08 Jul 2023 11:32:49 +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 CDA5F56C45 for ; Sat, 8 Jul 2023 11:32:48 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=TEn2Y8zz; 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=1688808769; 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=3rObM8D2nM1ivr0fRohztzSw7n5vy1sWu/gviWnjod8=; b=ktjh+0ONLK/OHelvBH+b18BXg9Yn8Vy8k5S3SEk6AsBHf6QZQpJRP1cES9Okou3VF+HLti PZEYsADKmJP95mIKo1CE4CJnqdlZoYwq5LeeZ2GFn9GS4zLxe7E1jO7j3GOhHruvY8arJO VsoQ5tdDfjhEkGOiU3THXW+QhQXzImzzm9wMM0YK9VRjeL9WLvqUc6I311OqefZPm+o6wL 76iXfNYUJ4LkrLmgGcXUx4U8g7CYibDK97r2moCo5V7Q72BhuM1O/rK02fsveTQPsv7TH/ UqjrOgjTOBYtk/0AUaBjLnXFoM0BelBGSomsh9pKEBdqcg1RlZAdUMNa9jEoLA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1688808769; a=rsa-sha256; cv=none; b=P5jLOWCQgydUKQyiTIBZmeOojPISYSFkgpEiDPVHIqWUZCiTZChrPZB+IZ/5Tle/fx27w4 q8AC4jT/z7jWZ1QTo/48gYcVHkaTVsBxUVdVE1lpxpN00coo0xzJCF4PPP48O7E2OFk4Ss PrcETYgLcTJU+NIStMIUpdgOSVGZ7bZsGMd16eo69aqVlLa6iQLB9QZsTTRqcfxwelC8Am tBAIMKWd1fZONIc08OiLG/ZDa5+PO1wUBSZEP345Vb//PWBgAynzTf+Rh25J+06nLc1uad 0ElY0eEqxQN0yri+JTOab0m0vesgRfyBPlCYhW8NSSUDjHLRxCtgmhymBO/O0A== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=TEn2Y8zz; 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 Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qI4IF-0005W0-7I; Sat, 08 Jul 2023 05:31:55 -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 1qI4I7-0005VU-J7 for emacs-orgmode@gnu.org; Sat, 08 Jul 2023 05:31:49 -0400 Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qI4I5-0006je-1c for emacs-orgmode@gnu.org; Sat, 08 Jul 2023 05:31:47 -0400 Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id B6AF3240027 for ; Sat, 8 Jul 2023 11:31:42 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1688808702; bh=AgBgw+x0XCJYPy+RM1yGQW6clPJoLh/yKf45WMUac2M=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:From; b=TEn2Y8zz/MHeXNVM02tft5OUcef1emqfT2YVULGulFPqE/w+ERQdMMy5vn4Mujzpt Sbi6VfAX7dRYFiJ2lXJNZnn/f0pAB3rU9np8FPhESfsr/ky7VbfxfDZqeaIQ1qnuHY M9zQ0n21n18RckSi2OHxWuMDIicwtpDU6+nKPb1t5g8Dcym6PmlfonxZ+RL8J9tCn/ xeW9bi8wjtPH7cFQYzQJs0OkN3FrZBv8oEcfXQGTwZWVbSRE9+Dy96yuipZdK2fwwV E6QKQm3wzg7ks+Il1UuE1xQ36SsLc269KdkdrAmSDrtb2Jnt51q4vQ5kbL3scJTTEZ E+zRIqbyNi+ew== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4QylQQ0HPCz9rxL; Sat, 8 Jul 2023 11:31:41 +0200 (CEST) From: Ihor Radchenko To: Max Nikulin Cc: emacs-orgmode@gnu.org Subject: Re: [PATCH v2] org-faq.org: Inline comments In-Reply-To: References: <5210ac1c-ed73-4b82-a296-41cf90b9f0a7@gmail.com> <87jzvmwnmw.fsf@localhost> Date: Sat, 08 Jul 2023 09:31:45 +0000 Message-ID: <87ilauagvy.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@posteo.net; helo=mout01.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, T_SCC_BODY_TEXT_LINE=-0.01 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-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Spam-Score: -7.75 X-Spam-Score: -7.75 X-Migadu-Queue-Id: CDA5F56C45 X-Migadu-Scanner: mx2.migadu.com X-TUID: RUA/WPEm/Lx0 Max Nikulin writes: >> The proposed FAQ entry is overwhelming. It would work fine as a blog, >> but not as a quick answer to a question. I recommend leaving only the >> @@comment:...@@ part > > See a shortened variant. Thanks! >> - it is what we use ourselves in WORG sources. > > I have not found it in the worg repository. There are enough @@html:@@ > with a handful of @@latex:@@. Yeah, not in WORG. https://orgmode.org/quickstart.html#text-comments > +** Is it possible to add inline comments? > +:PROPERTIES: > +:CUSTOM_ID: inline-comments > +:END: > + > +Unfortunately [[https://orgmode.org/manual/Comment-Lines.html][comments]] > +in Org mode are block-level elements, so they break paragraphs. Please, avoid "unfortunately". This reads kinda strange. Comments do break paragraphs, which is our design decision. Some people like it, some don't. > +It is safer to avoid export snippets having no other content before or after them > +on the same line. > +#+begin_src org > +The following line may become a patagraph separator. > +@@comment: might give unexpected effect @@ > +Put some text before @@comment: a better variant > +@@ and after instread. > +#+end_src May you please elaborate? If you see inline export block starting a paragraph, it is a bug. > +Alternatives are: > +a [[https://orgmode.org/manual/Macro-Replacement.html][macro]] > +expanding to nothing, > +a [[https://orgmode.org/manual/Adding-Hyperlink-Types.html][custom link type]] > +exporting to empty string, > +[[https://orgmode.org/manual/Structure-of-Code-Blocks.html][source code blocks]] > +with exporting and evaluation suppressed through default header arguments. Again, this is not helpful as FAQ entry. We do not need to provide overwhelming number of possibilities here. > +Unfortunately sites for hosting of open source code projects > +do not support such tricks and inline comments may appear in formatted > +=README.org= or other files. Why do we need to mention it here? If you really want to explain this problem, it should be a dedicated FAQ entry. Rendering Org files on Github and other sites has many more problems not limited to inline export snippets. -- Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at