[racket] planet/scribble and versions

From: Carl Eastlund (cce at ccs.neu.edu)
Date: Fri Sep 9 13:38:12 EDT 2011

That really depends on what you mean by "correct".  The :MAJOR:MINOR
form is recommended in planet because it allows you to link to bug fix
updates without changing your source code.  If the Scribble utilities
were to force a :MAJOR:=MINOR form, anyone copying these links would
no longer get code compatible with bug fix updates.  Since bug fix
updates are not supposed to change the interface of a package,
documentation for :MAJOR:X should still apply to :MAJOR:X+1 anyway.

Carl Eastlund

On Thu, Sep 8, 2011 at 9:36 PM, Neil Van Dyke <neil at neilvandyke.org> wrote:
> Are the macros for PLaneT package specs in "planet/scribble" correct?
> I haven't traced the code thoroughly, but if the output of
> "syntax-source-planet-package-symbol" will be used as-is for actual
> "require" during Scribble formatting... won't the ":MAJOR:MINOR" (not
> ":MAJOR:=MINOR") version let Scribble use a different version than the
> version that the ".scrbl" being formatted is coming from?
> I'm asking because McFly currently makes ":MAJOR:=MINOR" version references
> itself right now, but I just saw the current advice in the documentation is
> to let the "planet/scribble" module do the PLaneT package self-references
> for you:
> http://doc.racket-lang.org/planet/Developing_Packages_for_PLaneT.html#(part._.Create_.Documentation__.Optional_)
> --
> http://www.neilvandyke.org/
> _________________________________________________
>  For list-related administrative tasks:
>  http://lists.racket-lang.org/listinfo/users

Posted on the users mailing list.