Tracking issue for specification maintenance tasks

Open
#533 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the remaining checklist and issue #519, then inspect the specification sources and existing formatting or CI configuration mentioned in this issue. The work is done when the special cases are migrated and line lengths are consistently handled, with the completed tasks reflected in this tracker.

Written by the indexing model from the issue text.

Description

Maintenance Tracking Issue

The purpose of this issue is to identify and track various maintenance tasks which have accumulated concerning specification organization and development.

Remaining tasks
  • Migrate special cases to use math directives: https://github.com/data-apis/array-api/issues/519
  • Ensure line length is handled better, so text is readable and reviewable on GitHub without it scrolling off to the right. Either use regular line length settings (80, 88, 100, or 120 char), or set up something like EditorConfig to ensure consistent line endings and spacing.
  • Setup linting of Python files (black, pydocstyle) in CI.
Done for v2022
  • Move special cases and other explanatory content to a dedicated "notes" section: https://github.com/data-apis/array-api/issues/518
    • PR: gh-578
  • Add a short sentence about whether the special cases are derived from C99, from some other standard, or are based on analysis or existing practice in array libraries. See https://github.com/data-apis/array-api/pull/514#issuecomment-1337650301.
    • PR: gh-579
  • Use black for automated code formatting and line wrapping (possibly using Git hooks).
    • PR: gh-575
  • Move universal preamble content (e.g., positional parameters, optional parameters, etc) to a dedicated design document.
    • PR: gh-576
  • Merge the content in the "branch cuts", "complex number ordering" and "complex numbers" (about equality mostly) design topic pages into a single "complex number support" page.
Dominant language
Python
Stars
281
Forks
52
No merged PRs in 30d

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.

More from data-apis/array-api

All issues in data-apis/array-api

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.