Skip to content

Commit

Permalink
πŸ“ docs(vecs): docs for vconvert
Browse files Browse the repository at this point in the history
  • Loading branch information
nstarman committed Jan 3, 2025
1 parent 5c31b98 commit aa465a9
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion src/coordinax/_src/vectors/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@
def vconvert(target: type[Any], /, *args: Any, **kwargs: Any) -> Any:
"""Transform the current vector to the target vector.
See the dispatch implementations for more details.
See the dispatch implementations for more details. Not all transformations
result in the target vector type, for example
``vconvert(type[Cartesian3DPos], FourVector)`` will return a
`coordinax.vecs.FourVector` with the spatial part in Cartesian coordinates.
Likewise, `coordinax.vconvert` on `coordinax.Coordinate` instances will
transform the contained vectors to the target type, returning a
`coordinax.Coordinate` instance.
"""
raise NotImplementedError # pragma: no cover
Expand Down

0 comments on commit aa465a9

Please sign in to comment.