New evolve docs, take 2
Martin Geisler
martin at geisler.net
Fri May 30 10:00:49 UTC 2014
Pierre-Yves David <pierre-yves.david at ens-lyon.org> writes:
> On 05/28/2014 11:31 AM, Greg Ward wrote:
>> Hi all --
>>
>> I've been slowly plugging away at the new docs for evolve. It's time
>> for another round of peer review before I start sending drawing
>> figures "for real" and sending patches.
>
> Hooray \o/
Yes, really nice job!
>> Those of you who *have* reviewed the user guide: thanks! Please move
>> on to the sharing guide:
>>
>> http://www.gerg.ca/evolve/sharing.html
>>
>> Note that I haven't drawn any figures for that yet. You'll have to
>> use your imagination, or see test/test-sharing.t. (Every figure in
>> the docs should have an "hg log -G" in the test script.)
>
> The rest file and the .t file should be the same. That is the only way
> we have to make sure the documentation stay up to date.
I found it very useful to execute the code directly from the .rst file.
The setup commands often needed were executed as special hidden commands
that don't show up in the final documentation.
That allowed me to write "now please set your username in .hgrc" while
running the needed "echo" commands hidden in the background:
https://bitbucket.org/aragost/kick-start/src/tip/src/basic/index.txt#cl-123
--
Martin Geisler
http://google.com/+MartinGeisler
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 818 bytes
Desc: not available
URL: <http://lists.mercurial-scm.org/pipermail/mercurial-evolve-testers/attachments/20140530/97299d27/attachment.asc>
More information about the Evolve-testers
mailing list