Skip to content

Commit d38fc83

Browse files
Add another example for when to typehint as Vector
1 parent 431c675 commit d38fc83

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/source/contributing/docs/types.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ like ``direction=(0, 1, 0)``. You could type it as ``InternalPoint3D`` and
6666
the typechecker and linter would be happy; however, this makes the code harder
6767
to understand.
6868

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

7272
.. warning::
7373

0 commit comments

Comments
 (0)