search-engine API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Class Hierarchy

  • modules.api.ArxivApi - No class docstring; 0/8 instance variable, 4/4 methods documented
  • modules.api.RedditApi - No class docstring; 0/5 instance variable, 4/4 methods documented
  • modules.auth.RedditAuth - Class representing Reddit authentication credentials.
  • modules.author.Author - Class representing an author.
  • modules.corpus.Corpus - Class representing a corpus of documents.
  • modules.document.Document - Class representing a document.
    • modules.document.ArxivDocument - Class representing an Arxiv document.
    • modules.document.RedditDocument - Class representing a Reddit document.
  • modules.factory.DocumentFactory - Factory class for creating documents based on the type of process.
  • type
    • modules.singleton.SingletonMeta - Metaclass for implementing the Singleton design pattern.
API Documentation for search-engine, generated by pydoctor 23.9.1 at 2024-01-11 01:25:17.