From: Ihor Radchenko <yantar92@posteo.net>
To: Matt <matt@excalamus.com>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: Backwards compatibility (was: Re: [PATCH] ob-shell: consistent prefix)
Date: Sat, 20 Jan 2024 18:54:19 +0000 [thread overview]
Message-ID: <8734ur6dk4.fsf@localhost> (raw)
In-Reply-To: <18d279c9696.11f7c699f365957.5930695120108631730@excalamus.com>
Matt <matt@excalamus.com> writes:
> How far does backwards compatibility extend with regard to Org itself?
> For the next version, for all time, or something else?
Usually, until next major release (we should have major releases more
frequently in future).
However, we often keep compat code in place even much later if it does
not stay on the way of maintenance or implementing new features.
> The rule I infer from your comment is, "renamed symbols must be
> aliased." This implies that any arguments associated with the symbol
> are the same after the name change. How do we handle changes in
> function APIs? I'm thinking of something like
> =org-babel-execute:shell= and =org-babel-sh-evaluate= where it would
> make sense to refactor the =stdin= and =cmdline= parameters.
1. When we need to add new arguments, we usually add them as optional
arguments at the end.
2. When we need to remove arguments, we just keep the relevant arglist
names as _ (indicating that the argument is unused).
3. When API is changing more significantly, we obsolete the old function
code and keep it in org-compat. Then, we implement a completely new
function with a new name, and use it throughout Org mode.
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
prev parent reply other threads:[~2024-01-20 18:52 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-20 16:03 Backwards compatibility (was: Re: [PATCH] ob-shell: consistent prefix) Matt
2024-01-20 18:54 ` Ihor Radchenko [this message]
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=8734ur6dk4.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=matt@excalamus.com \
/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).