Skip to content

Commit

Permalink
Add another example for when to typehint as Vector
Browse files Browse the repository at this point in the history
  • Loading branch information
JasonGrace2282 committed Apr 1, 2024
1 parent 431c675 commit d38fc83
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/contributing/docs/types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ like ``direction=(0, 1, 0)``. You could type it as ``InternalPoint3D`` and
the typechecker and linter would be happy; however, this makes the code harder
to understand.

As a general rule, if a parameter is called ``direction`` it should be typehinted as
some form of ``Vector``.
As a general rule, if a parameter is called ``direction`` or ``axis``,
it should be typehinted as some form of ``Vector``.

.. warning::

Expand Down

0 comments on commit d38fc83

Please sign in to comment.