Open
Description
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: Migrate documentation of special cases to use math directives #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: Reorganize documentation to display parameters and return values more prominently #518
- 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 Add complex number support to
log
#514 (comment). - Use black for automated code formatting and line wrapping (possibly using Git hooks).
- Move universal preamble content (e.g., positional parameters, optional parameters, etc) to a dedicated design document.
- 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.