Skip to content

Migrate documentation of special cases to use math directives #519

Open
@kgryte

Description

@kgryte

The documentation of special cases in API documentation predates the specification's embrace of reST and GitHub support for mathematical equations in Markdown. As such, special cases use code blocks for numerical values and mathematical symbols. We should migrate to using math directives for better and more succinct rendering.

Adoption of math directives needs to be coordinated with the array API test suite, which, TMK, relies on special cases being described in a particular format within narrative content. Migration to math directives would thus break the test suite's current parsing logic for extracting special values and the associated expected result.

During this migration, we may want to consider providing structured data (e.g., as JSON) describing special cases which can be more readily consumed by downstream consumers, such as the array API test suite, and prevent implicit dependencies on how narrative content is written.

Metadata

Metadata

Assignees

No one assigned

    Labels

    MaintenanceBug fix, typo fix, or general maintenance.Narrative ContentNarrative documentation content.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions