I think that code is great and is often self-documenting, but it only
represents the result of someone writing the code, it doesn't explain
the why part of it. So, it would need English (and translations???)
to explain why a particular approach was taken, along with possible
alternatives.
On Feb 15, 2007, at 2:25 PM, Erik Hatcher (JIRA) wrote:
[ https://issues.apache.org/jira/browse/LUCENE-805?
page=com.atlassian.jira.plugin.system.issuetabpanels:comment-
tabpanel#action_12473480 ]
Erik Hatcher commented on LUCENE-805:
-------------------------------------
That was my concern as well, Grant. At least the LIA code is
fairly well self documenting (we used JUnit for a reason :) and the
build file itself is a nice example of how to launch applications
and examples from a common starting point.
What other documentation would be needed to make this a palatable?
New Lucene Demo
---------------
Key: LUCENE-805
URL: https://issues.apache.org/jira/browse/LUCENE-805
Project: Lucene - Java
Issue Type: Improvement
Components: Examples
Reporter: Grant Ingersoll
Assigned To: Grant Ingersoll
Priority: Minor
The much maligned demo, while useful, could use a breath of fresh
air. This issue is to start collecting requirements about what
people would like to see in a demo and what they don't like in the
current one.
Ideas (not necessarily in order of importance):
1. More in-depth tutorial explaining indexing/searching
2. Multilingual support/demonstration
3. Better demonstration of querying capabilities: Spans, Phrases,
Wildcards, Filters, sorting, etc.
4. Dealing with different content types and pointers to resources
5. Wiki use cases links -- I think it would be cool to solicit
people to contribute use cases to the docs.
6. Demonstration of contrib packages, esp. Highlighter
7. Performance issues/factors/tradeoffs. Lucene lessons learned
and best practices
Advanced tutorials:
1. Hadoop + Lucene
2. Writing custom analyzers/filters/tokenizers
3. Changing Scoring
4. Payloads (when they are committed)
Please contribute what else you would like to see. I may be able
to address some of these issues for my ApacheCon talk, but not all
of them.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
------------------------------------------------------
Grant Ingersoll
http://www.grantingersoll.com/
http://www.paperoftheweek.com/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
