bundles / traitlets 5.15.0 / traitlets / utils / descriptions / add_article

function

`traitlets.utils.descriptions:add_article`

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

Signature

   def     add_article (    name  :  str    ,    definite  :  bool    =  False   ,    capital  :  bool    =  False     )   →  str

Summary

Returns the string with a prepended article.

Extended Summary

The input does not need to begin with a character.

Parameters

name : str: Name to which to prepend an article
definite : bool (default: False): Whether the article is definite or not. Indefinite articles being 'a' and 'an', while 'the' is definite.
capital : bool (default: False): Whether the added article should have its first letter capitalized or not.

Aliases

traitlets.traitlets.add_article