Skip to content

RFC: split docscrape out into separate repo #619

Open
@lucascolley

Description

@lucascolley

SciPy has a one-to-one copy of https://github.com/numpy/numpydoc/blob/main/numpydoc/docscrape.py at https://github.com/scipy/scipy/blob/main/scipy/_lib/_docscrape.py. From the file, we use:

  • ClassDoc
  • NumpyDocString
  • FunctionDoc
  • Parameter

The use is exclusive to a deprecation utility and some places in scipy.stats.

It seems overkill to add the entirety of numpydoc as a submodule, such that keeping the current carbon copy is probably preferable.

Would it be feasible, though, for this file to be maintained separately as numpy/docscrape? On the one hand, this would reduce duplication, as we could add that as a submodule in SciPy. On the other hand, maybe this would require an unwarranted amount of maintenance/release effort, and we are better off living with the current state of things.

Thoughts?

x-ref scipy/scipy#21232

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions