fix: docs and types

[ematipico]

Changes

• fixes some issue in the docs (incorrect position and indentation)
• fixes types exposed to the users
• renamed an error to be more descriptive

Testing

CI should pass

Docs

/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4a88144

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[codspeed-hq]

CodSpeed Performance Report

Merging #13087 will not alter performance

_{Comparing chore/fix-docs-issue (e2c56f6) with main (18a2699)}

Summary

✅ 6 untouched benchmarks

[sarah11918]

Thank you!