summaryrefslogtreecommitdiff
path: root/numpydoc/xref.py
Commit message (Collapse)AuthorAgeFilesLines
* Run black formatterJarrod Millman2022-05-071-54/+52
|
* Use fstrings (#353)Jarrod Millman2022-01-101-3/+3
| | | Convert string formatting to f-strings with flynt
* Avoid mutable default arguments (#342)Dimitri Papadopoulos Orfanos2021-12-161-1/+1
| | | | | | | While they are not always an actual bug, they are certainly a Python anti-pattern and possible the source of future bugs. In at least one case, the default mutable argument `config` is actually modified later on by the function.
* ALTERNATIVE: overload xref_ignore config valueRoss Barnowski2020-08-211-12/+19
|
* DOC: document config value/kwargRoss Barnowski2020-08-171-0/+5
|
* WIP: kwarg to ignore unknown terms in make_xref.Ross Barnowski2020-08-171-3/+5
| | | | | Add a kwarg to make_xref to toggle the automatic wrapping of every term not in xref_ignore in an :obj: role.
* MAINT: Updates related to xref (#292)Ross Barnowski2020-08-051-2/+4
| | | | | | | | | | | | | * TST: use default links in xref test. Switch to numpydoc's default link mapping for test_xref instead of the custom (less comprehensive) link mapping. * DOC: rm statements about xref_alias dict. Default aliases are not an empty dict, nor are they dependent on intersphinx. * DOC: Update make_xref docstring.
* MAINT: fix trivial source comment typosluz.paz2019-05-291-1/+1
| | | Found via `codespell`
* ENH: Just use objEric Larson2019-04-171-49/+43
|
* FIX: Opt-in, test, uniform styling, cssEric Larson2019-04-171-8/+12
|
* Add cross-reference links to parameter typesHassan Kibirige2019-04-171-0/+185
Tokens of the type description that are determined to be "link-worthy" are enclosed in a new role called `xref_param_type`. This role when when processed adds a `pending_xref` node to the DOM. If these types cross-references are not resolved when the build ends, sphinx does not complain. This forgives errors made when deciding whether tokens are "link-worthy". And provided text from the type description is not lost in the processing, the only unwanted outcome is a type link (due to coincidence) when none was desired.