basic 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

Summary of Undocumented Objects

  • Module - basic._private_mod
  • Function - basic._private_mod.f
  • Class - basic.mod.C.S
  • Class Method - basic.mod.C.cls_method
  • Instance Variable - basic.mod.C.notreally
  • Static Method - basic.mod.C.static_method
  • Variable - basic.mod.CONSTANT
  • Class - basic.mod.D.T
  • Class Method - basic.mod.D.cls_method2
  • Method - basic.mod.D.g
  • Static Method - basic.mod.D.static_method2
  • Function - basic.mod._private
API Documentation for basic, generated by pydoctor 23.9.1 at 2024-02-24 18:12:56.