Skip to content

Stop repeating input/output type info in docstrings #454

Open

Description

@leofang

I think Sphinx is able to figure out the types and keep them in the document by inspecting the typing info, which going forward should be our source of truth (#312 (comment)). We should not repeat ourselves.

Activity

  1. added
    cuda.coreEverything related to the cuda.core module
    documentationImprovements or additions to documentation
    P1Medium priority - Should do
    on Feb 18, 2025
  2. added this to the cuda.core beta 4 milestone on Feb 18, 2025
  3. leofang commented on Feb 24, 2025

    @leofang
    MemberAuthor

    I noticed there are some issues for Sphinx to handle type alias properly. We need to proceed with caution.

    sphinx-doc/sphinx#11991

  4. leofang commented on Jun 11, 2025

    @leofang
    MemberAuthor

    Found another relevant issue: sphinx-doc/sphinx#7077, and someone pointed to the sphinx-autodoc-typehint plugin: sphinx-doc/sphinx#7077 (comment)

  5. added
    cuda.coreEverything related to the cuda.core module
    and removed
    cuda.coreEverything related to the cuda.core module
    on Apr 2, 2026
  6. removed this from the cuda.core backlog milestone on Apr 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1Medium priority - Should docuda.coreEverything related to the cuda.core moduledocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions