`traitlets.utils.descriptions:describe`

source: /traitlets/utils/descriptions.py :9

Signature

   def     describe (    article  :  str | None    ,    value  :  Any    ,    name  :  str | None    =  None   ,    verbose  :  bool    =  False   ,    capital  :  bool    =  False     )   →  str

Summary

Return string that describes a value

Parameters

article : str or None: A definite or indefinite article. If the article is indefinite (i.e. "a" or "an") the appropriate one will be inferred. Thus, the arguments of describe can themselves represent what the resulting string will actually look like. If None, then no article will be prepended to the result. For non-articled description, values that are instances are treated definitely, while classes are handled indefinitely.
value : any: The value which will be named.
name : str or None (default: None): Only applies when article is "the" - this name is a definite reference to the value. By default one will be inferred from the value's type and repr methods.
verbose : bool (default: False): Whether the name should be concise or verbose. When possible, verbose names include the module, and/or class name where an object was defined.
capital : bool (default: False): Whether the first letter of the article should be capitalized or not. By default it is not.

Examples

Indefinite description:

describe("a", object())
describe("a", object)
describe("a", type(object))

Definite description:

describe("the", object())
describe("the", object)
describe("the", type(object))

Definitely named description:

describe("the", object(), "I made")
describe("the", object, "I will use")

Aliases

traitlets.traitlets.describe