numpy / numpy/numpydoc

Remove Numpy*Domains?

Open
#138 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs-decision
Dominant language
Python
Stars
355
Forks
181
Avg merge
1d 9h
Merged PRs (30d)
3

Description

From #134:

Some tracing tells me that wrap_mangling_directives results in NumpyPythonDomain's directives being used to handle py:class, py:function, etc. I find it hard to believe that that's the intention.

Do these domains remain relevant? I can't see any reference to them in the numpy or scipy repositories currently. I see that @pv commented on their likely irrelevance in 2012.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing wrap_mangling_directives and the NumpyPythonDomain directives that handle py:class and py:function. Check the repository for references to these domains and compare their relevance with the linked NumPy and SciPy usage; done means the obsolete domains are removed or their continued purpose is documented and verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.