Open kgryte opened 1 year ago
Thanks for summarizing this @kgryte. A few thoughts:
git blame
, by using https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-viewblack
"The v2022 tasks are done. I reorganized the description so it's clear what is left, and removed the milestone.
As commented in https://github.com/data-apis/array-api/pull/689#discussion_r1449622314, we should investigate whether we can minimize type annotation duplication. Currently, we copy-paste the type annotation from the signature into the docstring. This increases the risk of drift, and preferably, we'd only need to write these annotations once.
Sphinx has functionality for that (autodoc_typehints
), but like anything autodoc
related it had some issues, especially with dealing with type aliases. Not sure if that has been improved recently, but I did try this when initially setting up the docs.
If I had to deal with this now, I'd dump Sphinx complete in favor of MkDocs / mkdocs-material.
Sphinx has functionality for that...I'd dump Sphinx completely...
Yeah, we should revisit once we have v2023 released.
The purpose of this issue is to identify and track various maintenance tasks which have accumulated concerning specification organization and development.
Remaining tasks
black
,pydocstyle
) in CI.Done for v2022