Skip to content

docs: Docs pass for 0.1 - #176

Merged
kylebarron merged 16 commits into
mainfrom
kyle/manual-docs-pass
Aug 11, 2026
Merged

docs: Docs pass for 0.1#176
kylebarron merged 16 commits into
mainfrom
kyle/manual-docs-pass

Conversation

@kylebarron

@kylebarron kylebarron commented Aug 11, 2026

Copy link
Copy Markdown
Member

Change list

  • Updated README.md, written by me by hand.
  • Added new types that were missing and didn't have an interlink (e.g. Selection, AxisSelector, SupportsDLPack).
  • Reduced duplication of type definitions across type hints and python source, e.g. for codecs
  • Used show_root_heading: false which makes it look nice to document an entire module in a markdown file. E.g. look in codec.md.
  • Imports exceptions into scope in relevant files so that Raises sections can interlink
  • Fix formatting of Returns: block, so that it's all kept in a single return render
  • New Claude skill for auditing docs, which should be done in advance of every release (and claude will probably use automatically when adding new methods)

@kylebarron kylebarron changed the title Kyle/manual docs pass docs: Docs pass for 0.1 Aug 11, 2026
@kylebarron
kylebarron merged commit 93e357b into main Aug 11, 2026
15 checks passed
@kylebarron
kylebarron deleted the kyle/manual-docs-pass branch August 11, 2026 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant