[darcs-devel] [issue1216] improve documentation of matchers

Jason Dagit bugs at darcs.net
Mon Nov 10 09:32:15 UTC 2008


New submission from Jason Dagit <dagit at codersbase.com>:

Please make matchers into an easier to find section.

Matchers are very powerful, but finding them in the manual can be a bit tricky.
 For example, the interactive help just says:
Options:
             --matches=PATTERN               select patches matching PATTERN

Going to the darcs manual there is no clearly marked section for learning about
what makes up a valid PATTERN.

To find patterns you have to go here:
http://www.darcs.net/manual/node8.html#SECTION00810000000000000000

They are defined in the section "Match".

I think this section is mostly adequate.  It would be nice if there was a table
that listed all the matches in a nice simple format with an example.

Probably the easiest and more important change we can make is to make
matches/patterns be mentioned in the table of contents and have the interactive
help suggest the user go look there.

----------
assignedto: twb
messages: 6630
nosy: dagit, dmitry.kurochkin, kowey, simon, thorkilnaur, twb
priority: wishlist
status: unread
title: improve documentation of matchers

__________________________________
Darcs bug tracker <bugs at darcs.net>
<http://bugs.darcs.net/issue1216>
__________________________________


More information about the darcs-devel mailing list