Re: [racket-dev] Documentation
Should the history.txt files get stuck into the end of the manuals for the time being? Robby On Sun, Dec 8, 2013 at 8:37 AM, Matthew Flatt wrote: > At Sun, 8 Dec 2013 11:09:39 +0100, Jens Axel Søgaard wrote: > > In cases where the semantics of constructs are changed, should the > > documentation have a margin note stating the version number of the > > change? > > Yes, it really should. > > Details like this get listed in "HISTORY.txt" (the `case` form > apparently changed in v5.3.2), but no one ever reads "HISTORY.txt", and > we frequently forget to update it. Putting change information in the > documentation is clearly better. > > Unless someone has an even better idea, I'll add a suitable form to > `scribble/manual` and start trying to record changes this way. > > > Matthew > > > _ > Racket Developers list: > http://lists.racket-lang.org/dev > _ Racket Developers list: http://lists.racket-lang.org/dev
Re: [racket-dev] Documentation
At Sun, 8 Dec 2013 11:09:39 +0100, Jens Axel Søgaard wrote: > In cases where the semantics of constructs are changed, should the > documentation have a margin note stating the version number of the > change? Yes, it really should. Details like this get listed in "HISTORY.txt" (the `case` form apparently changed in v5.3.2), but no one ever reads "HISTORY.txt", and we frequently forget to update it. Putting change information in the documentation is clearly better. Unless someone has an even better idea, I'll add a suitable form to `scribble/manual` and start trying to record changes this way. Matthew _ Racket Developers list: http://lists.racket-lang.org/dev
[racket-dev] Documentation
In cases where the semantics of constructs are changed, should the documentation have a margin note stating the version number of the change? I am in particular thinking of "case": http://docs.racket-lang.org/reference/case.html#%28form._%28%28lib._racket%2Fprivate%2Fmore-scheme..rkt%29._case%29%29 /Jens Axel _ Racket Developers list: http://lists.racket-lang.org/dev
