Improve examples in documentation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Hypy |
Fix Released
|
High
|
Cory Dodt | ||
1.0+or+bust |
Fix Released
|
High
|
Cory Dodt |
Bug Description
Extend the documentation with more examples. It is very difficult to find out good information
(short of undocumented unit tests) on how to do things like attribute searches, or even simple stuff like how many documents are in the index.
- attribute searches
- len() on indexes
- ...
Also document estmaster use with Hypy, if we can easily ascertain whether it is doable. My response so far is:
"""
Hypy doesn't do anything unusual with indexes, or even really interact
with them on that level - all access to the database, including
creation, is done through Hyper Estraier APIs. So yeah, it should
work, but I haven't tried it. However, Hypy itself doesn't yet
support any of that federated search stuff, so an application that
accessed an index through Hypy would not, e.g., be able to eclipse
results; but any *other* application that accessed the same index
would be able to use it that way with no problems.
"""
Changed in hypy: | |
status: | Fix Committed → Fix Released |
Jamie, any thoughts you have here about what should be documented would be good. I can add some prose around the various attribute search unit tests, but there's probably other specific things you want to get. Even if you've already figured them out, this is for posterity.