pydocspec 0.0.0 API Documentation Modules Classes Names

search in docstrings

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

Module test_docstring

Functions

test_docstring

Package ext

Modules

test_attrs
test_dataclasses
test_django
test_docstring
test_zopeinterface

`pydocspec.test.ext.test_docstring`

module documentation

(source)

Undocumented

Function test_docstring Undocumented

def test_docstring(): (source)

Undocumented

API Documentation for pydocspec 0.0.0, generated by pydoctor 22.5.0.dev0 at 2022-04-29 00:33:08.