caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Alain Frisch <alain.frisch@lexifi.com>
To: Enrico Tassi <enrico.tassi@inria.fr>, caml-list@inria.fr
Subject: Re: [Caml-list] How to rename a record field
Date: Thu, 6 Sep 2018 18:20:49 +0200	[thread overview]
Message-ID: <3bd16eb6-392e-51ea-03e0-1180ee47d2e5@lexifi.com> (raw)
In-Reply-To: <20180906113622.lcuamhs6g6juv2r5@gargamel>

On 06/09/2018 13:36, Enrico Tassi wrote:
> Dear caml-list, while refining an API I felt the need to rename a record
> field. I'd like to be nice to my users and have the API evolve without
> breaking compilation but eventually emitting deprecation warnings.

If you could go back in time, the best solution might be to avoid 
exposing a concrete record type, but rather a constructor function (and 
possibly deconstructors, if needed).  Thanks to optional arguments in 
particular, this enables a smoother experience for evolving the API 
(e.g. by adding new fields, with a natural default value).

Btw, it might be interesting to allow deprecating the presence or 
absence of fields.

-- Alain

-- 
Caml-list mailing list.  Subscription management and archives:
https://sympa.inria.fr/sympa/arc/caml-list
Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
Bug reports: http://caml.inria.fr/bin/caml-bugs

  parent reply	other threads:[~2018-09-06 16:21 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-06 11:36 Enrico Tassi
2018-09-06 11:48 ` Gabriel Scherer
2018-09-06 13:03   ` Enrico Tassi
2018-09-06 13:17     ` Jacques Garrigue
2018-09-06 14:18       ` Enrico Tassi
2018-09-06 23:34         ` Jacques Garrigue
2018-09-06 16:20 ` Alain Frisch [this message]
2018-09-06 16:21   ` Alain Frisch
2018-09-06 23:45     ` Jacques Garrigue
2018-09-07  8:36       ` Alain Frisch
2018-09-07 10:13         ` Jacques Garrigue
2018-09-07 12:49           ` Alain Frisch

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

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

  git send-email \
    --in-reply-to=3bd16eb6-392e-51ea-03e0-1180ee47d2e5@lexifi.com \
    --to=alain.frisch@lexifi.com \
    --cc=caml-list@inria.fr \
    --cc=enrico.tassi@inria.fr \
    /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.
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 NNTP newsgroup(s).