Thank you so much :) <br><br>-Regards<br>Aarsh<br><div class="gmail_quote">On Thu, Jan 24, 2013 at 3:07 PM, Olly Betts <span dir="ltr">&lt;<a href="mailto:olly@survex.com" target="_blank">olly@survex.com</a>&gt;</span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="im">On Wed, Jan 23, 2013 at 10:45:42AM +0530, aarsh shah wrote:<br>
&gt; Hi Olly :) I guess you are busy these days.<br>
<br>
</div>We have visitors staying at the moment, so I&#39;m afraid I&#39;m not online as<br>
much as I typically am.  It sounds like you&#39;re making good progress<br>
unaided though!<br>
<div class="im"><br>
&gt; Please can you just let me know about the  documentation standards<br>
&gt; and expectations that the community has.Want to document the stemmer code<br>
&gt; as nicely as I can :)<br>
<br>
</div>I&#39;d recommend reading the advice in the &quot;HACKING&quot; document, which is in<br>
the source tree in xapian-core/HACKING, but you can see it online too.<br>
It&#39;s useful to look through all of it if you&#39;re working on the code, but<br>
the part which is particular pertinent starts here:<br>
<br>
<a href="http://trac.xapian.org/browser/trunk/xapian-core/HACKING#L1043" target="_blank">http://trac.xapian.org/browser/trunk/xapian-core/HACKING#L1043</a><br>
<br>
For a patch like this, there&#39;s not a lot of user documentation needed -<br>
look to see where we say which stemmers we offer and update those<br>
places.  It&#39;s an implementation on an existing algorithm, so a link to<br>
wherever it is officially described would be useful.<br>
<br>
For a new stemming algorithm, test coverage is quite important.  We want<br>
to check that it implements the described algorithm, so any examples<br>
from the description should definitely be in the test data.  Also make<br>
sure each rule in the stemmer (assuming it is rule based) has at least<br>
one example which exercises it in the test data.  It&#39;s also good to<br>
stem the english word list we already have with the new stemmer and<br>
include that, which helps to ensure it doesn&#39;t crash or hang on those<br>
inputs, and that it continues to return the same results for them in<br>
the future (which is useful even if those results haven&#39;t all been<br>
checked by hand).<br>
<br>
The data files for stemming tests live in xapian-data/stemming/ in<br>
the source tree.<br>
<br>
If there&#39;s one or more existing implementations available, then it&#39;s<br>
useful to run the english word list through those too and compare the<br>
results with what you get.<br>
<br>
Cheers,<br>
    Olly<br>
</blockquote></div><br>