您可以搜索模块、包、类、函数、方法和属性的定义。
如果启用“在文档字符串中搜索”,可以使用名称的部分或全部和/或其文档字符串来搜索这些项目。多个搜索词可以用空格分隔。
搜索由 lunrjs 提供支持。
默认情况下,搜索仅匹配对象的名称。通过选中复选框选项,启用文档字符串中的全文搜索。
您可以通过在搜索中传入字段名称来指示搜索仅在特定字段中查找,例如docstring:term.
可能的字段是:
最后两个字段仅在启用“在文档字符串中搜索”时适用。
默认行为是为匹配查询中多个术语的对象提供更好的排名,但仍显示仅匹配两个术语之一的条目。要更改此行为,可以使用符号+.
如果查询中的每个术语不包含显式的术语存在(+或-),则会自动在每个术语后添加一个尾部通配符。搜索foo与搜索foo*.
相同。如果查询包含点(.),则还会添加一个前导通配符,搜索model.与*model.*和.model与*.model*.
相同。除了这个自动功能外,您还可以在查询中的任何其他位置手动添加通配符。