Skip to content

DOC: refactor information in user and reference sections of the docs #12261

Closed

Description

@mattip

Our documentation repeats information. The PyArray_SimpleNew family of functions is documented both in the user section and in the reference section.

Also, the distutils section should be moved to user, not reference, and cleaned up.

See also #12250

Activity

  1. rgommers commented on Nov 5, 2018

    @rgommers
    Member

    Also, the distutils section should be moved to user, not reference, and cleaned up.

    No not that section, that is the reference guide content and is in the right place. I was talking about https://github.com/numpy/numpy/blob/master/doc/DISTUTILS.rst.txt, which is not the same - that's a standalone file now that looks more like user guide material.

  2. added a commit that references this issue on Apr 2, 2019
  3. mattip commented on May 26, 2019

    @mattip
    MemberAuthor

    Closing this, even though the PRs that relate to distutils are not done yet, since the information in the PRs is more extensive than in this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions