diff options
| author | Arun Isaac | 2022-10-17 01:45:03 +0530 |
|---|---|---|
| committer | Arun Isaac | 2022-10-17 01:45:33 +0530 |
| commit | 255febe168c2fb3e8182464a218b2951503b92a8 (patch) | |
| tree | 41aa6ce93e57f6bdabdc0e11da32336c012f6a78 /xapian/xapian.scm | |
| parent | 410e78b472b5195f799a75507e5e3c4ec7e03650 (diff) | |
| download | guile-xapian-255febe168c2fb3e8182464a218b2951503b92a8.tar.gz guile-xapian-255febe168c2fb3e8182464a218b2951503b92a8.tar.lz guile-xapian-255febe168c2fb3e8182464a218b2951503b92a8.zip | |
xapian: Add docstring to index-text!.
* xapian/xapian.scm (index-text!): Add docstring.
Diffstat (limited to 'xapian/xapian.scm')
| -rw-r--r-- | xapian/xapian.scm | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/xapian/xapian.scm b/xapian/xapian.scm index f22cfee..94eb1b3 100644 --- a/xapian/xapian.scm +++ b/xapian/xapian.scm @@ -149,6 +149,9 @@ bytevector." term-generator)) (define* (index-text! term-generator text #:key (wdf-increment 1) prefix) + "Index @var{text} using @var{term-generator}. @var{wdf-increment} is +the within document frequency increment. @var{prefix} is the term +prefix to use." (apply TermGenerator-index-text term-generator text wdf-increment (if prefix (list prefix) '()))) |