My view has always been that our manual is written for and accessible
to our users. These include many people who are not developers,
and ought not to be placed in a position of needing to search through
a gittrac ticket to find details. There are also those that cannot
do web access at the point in time where they might need to see what
was in that ticket you wish to refer to. A further point is that
the contents of our tickets are not generally the public face of our
project that we wish to present.
So, no links/references to the tickets in the version history (other
than the obligatory ticket number in a comment). Give a brief
description. If there is further documentation that ought to be
present in the manual WRT ticket info, then we'll do that.
Karen
On 8/9/2011 2:00 PM, Matthew Farrellee wrote:
I'm about to add some text to the 7-7.history.tex and I'd like to say
"fixed blah blar blag, for details see gt#123", with an actual reference
to gittrac. I see many entries have a gt# in comments but not the
history entries themselves.
What's accepted practice here? How can I reference gt from the version
history?
Best,
matt
_______________________________________________
Condor-devel mailing list
Condor-devel@xxxxxxxxxxx
https://lists.cs.wisc.edu/mailman/listinfo/condor-devel
