emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "João Pedro" <jpedrodeamorim@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [DOC] Mismatch on doc regarding position of src block switches
Date: Sun, 21 Apr 2024 23:05:50 -0300	[thread overview]
Message-ID: <87zftm2ltt.fsf@ergo> (raw)

Hi Org folks,

I've noticed that in (org)Literal Examples[0], when documenting the switches for example and source blocks, it is mentioned that they should be placed at the *end* of the #+BEGIN line, while both in (org)Structure of Code Blocks[1] and the Org Syntax document[2] the switches are documented to be placed right after the language (when appropriate), which is the correct placement for it.

I've also noticed that the Org Syntax for blocks (greater or lesser) don't mention example blocks having optional switches.

[0] https://orgmode.org/manual/Literal-Examples.html
[1] https://orgmode.org/manual/Structure-of-Code-Blocks.html
[2] https://orgmode.org/worg/org-syntax.html#Blocks

Cheers,

-- 
João Pedro de A. Paula
IT bachelors at Universidade Federal do Rio Grande do Norte (UFRN)

             reply	other threads:[~2024-04-22  2:07 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-22  2:05 João Pedro [this message]
2024-04-22 18:12 ` [DOC] Mismatch on doc regarding position of src block switches Ihor Radchenko
2024-04-22 21:59   ` João Pedro

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87zftm2ltt.fsf@ergo \
    --to=jpedrodeamorim@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).