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

# ``igraph`.`drawing`.`metamagic`.`AttributeSpecification``

class documentation

`class AttributeSpecification: (source)`

Constructor: `AttributeSpecification(name, default, alt_name, transform, func)`

View In Hierarchy

Class that describes how the value of a given attribute should be retrieved.

The class contains the following members:

- `name`: the name of the attribute. This is also used when we are trying to get its value from a vertex/edge attribute of a graph.
- `alt_name`: alternative name of the attribute. This is used when we are trying to get its value from a Python dict or an `igraph.Configuration` object. If omitted at construction time, it will be equal to `name`.
- `default`: the default value of the attribute when none of the sources we try can provide a meaningful value.
- `transform`: optional transformation to be performed on the attribute value. If `None` or omitted, it defaults to the type of the default value.
- `func`: when given, this function will be called with an index in order to derive the value of the attribute.

Method | `__init__` | Undocumented
Class Variable | `__slots__` | Undocumented
Instance Variable | `accessor` | Undocumented
Instance Variable | `alt_name` | Undocumented
Instance Variable | `default` | Undocumented
Instance Variable | `func` | Undocumented
Instance Variable | `name` | Undocumented
Instance Variable | `transform` | Undocumented

def __init__(self, name, default=None, alt_name=None, transform=None, func=None): (source)

Undocumented

__slots__: `tuple[str, ...]` = (source)

Undocumented

accessor = (source)

Undocumented

alt_name = (source)

Undocumented

default = (source)

Undocumented

func = (source)

Undocumented

name = (source)

Undocumented

transform = (source)

Undocumented