ipython / ipython/ipython

Sphinx consfuses numpydoc `set` type in docstring with set method

Open
#10,659 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
16.8k
Forks
4.5k
Avg merge
1d 2h
Merged PRs (30d)
6

Description

```
ipython/IPython/display.py:docstring of IPython.display.display:: WARNING: more than one target found for cross-reference 'set': IPython.core.interactiveshell.DisplayTrap.set, IPython.core.ultratb.DisplayTrap.set, IPython.testing.iptest.Event.set
```

Something like :

```
Parameters
----------
...
include : list, tuple or set, ...
...

````

get (for example, linked to `IPython.core.interactiveshell.html#IPython.core.interactiveshell.DisplayTrap.set`)

I'm going to guess it might be a fix in numpydoc to enforce `set` to be builtins. Unsure.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.