[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: svn commit: r1869945 - /subversion/site/staging/docs/release-notes/1.14.html

From: Nathan Hartman <hartman.nathan_at_gmail.com>
Date: Mon, 18 Nov 2019 10:46:58 -0500

On Mon, Nov 18, 2019 at 10:16 AM Daniel Shahaf <d.s_at_daniel.shahaf.name>
wrote:

> Nathan Hartman wrote on Sun, 17 Nov 2019 15:37 +00:00:
> > In that case, here's a thought: We can put a short message in a yellow
> > box: "Python is optional. Read more below." That would link to a
> > regular h3 section with the detailed text...
>
> +1
>
> Furthermore, we have the option of making the box link to the INSTALL
> file directly so we don't have to maintain the same information in
> two places.
>

The only problem with this idea is that the link won't take the reader
directly to the information about Python. INSTALL contains a lot of
other information to wade through. Also, INSTALL is aimed at people
building or packaging Subversion whereas the release notes are for
everyone, including users who just want to know what's new in the
latest version.

My original purpose in mentioning that Python is optional was to help
avoid confusion. We can't assume that whoever reads the release notes
knows that Subversion isn't implemented in Python and that this change
only affects certain use cases.

I'd rather leave the information in the release notes, but put it in a
normal section and leave just a short sentence in a yellow note box.

Does that make sense?

Nathan
Received on 2019-11-18 16:47:14 CET

This is an archived mail posted to the Subversion Dev mailing list.