Skip to content

Documentation overhaul: README, Google-style docstrings, usage guides, API reference fixes#16

Merged
VoxleOne merged 3 commits intomainfrom
copilot/copilot-changes
Mar 24, 2026
Merged

Documentation overhaul: README, Google-style docstrings, usage guides, API reference fixes#16
VoxleOne merged 3 commits intomainfrom
copilot/copilot-changes

Conversation

Copy link
Contributor

Copilot AI commented Mar 24, 2026

Full documentation rewrite so a new user can install, import, and use all 4 public classes without guessing. Fixes incorrect API signatures in the reference docs, adds missing guides, and standardizes docstring format.

README.md

  • Restructured with: Overview, Installation, Quick Start, Core Concepts, Examples, Optional Dependencies, Development, License
  • Removed speculative/conceptual sections; every code snippet is verified executable

Docstrings (Google-style)

  • Converted Node, QuaternionDepthIterator, DiscreteOrientationSet, DiscreteQuaternionIterator from NumPy-style to Google-style (Args:/Returns:/Raises:/Example::)

API Reference (docs/09-api-reference.md)

  • Fixed spinstep.continuous.QuaternionDepthIteratorspinstep.traversal.QuaternionDepthIterator
  • Fixed QuaternionDepthIterator.__init__ signature (was missing rotation_step_quat, showed wrong params)

New usage guides

  • docs/getting-started.md — install + first example
  • docs/continuous-traversal.mdQuaternionDepthIterator usage, threshold behavior, edge cases
  • docs/discrete-traversal.mdDiscreteOrientationSet factories + DiscreteQuaternionIterator
  • docs/faq.md — pitfalls, GPU vs CPU, optional deps, quaternion format

Consistency fixes

  • Fixed broken cross-reference links in docs/02-architecture.md (underscores → hyphens)
  • Updated docs/index.md to link new guides
from spinstep import Node, QuaternionDepthIterator

root = Node("root", [0, 0, 0, 1], [
    Node("child", [0.2588, 0, 0, 0.9659])  # ~30° around Z
])

for node in QuaternionDepthIterator(root, [0.2588, 0, 0, 0.9659]):
    print(node.name)

No implementation logic changed. All 46 tests pass unchanged.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits March 24, 2026 18:36
Stage 2: README restructured with Overview, Installation, Quick Start,
Core Concepts, Examples, Optional Dependencies, Development, License.

Stage 3: All public class docstrings converted to Google-style format
with Args/Returns/Raises/Example sections.

Stage 4: Created docs/getting-started.md, docs/continuous-traversal.md,
docs/discrete-traversal.md, docs/faq.md. Fixed docs/09-api-reference.md
with correct signatures and module paths. Updated docs/index.md.

Stage 5: All examples validated — every code snippet runs without error.

Co-authored-by: VoxleOne <119956342+VoxleOne@users.noreply.github.com>
Agent-Logs-Url: https://github.com/VoxleOne/SpinStep/sessions/9c6faf98-3686-45a3-9659-1c604bb18a00
Copilot AI changed the title [WIP] Update documentation for package installation and usage Documentation overhaul: README, Google-style docstrings, usage guides, API reference fixes Mar 24, 2026
Copilot AI requested a review from VoxleOne March 24, 2026 18:41
@VoxleOne VoxleOne marked this pull request as ready for review March 24, 2026 18:55
@VoxleOne VoxleOne merged commit 21aac44 into main Mar 24, 2026
4 checks passed
@VoxleOne VoxleOne deleted the copilot/copilot-changes branch March 24, 2026 18:55
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.

2 participants