Skip to content

Commit

Permalink
Test documentation porting
Browse files Browse the repository at this point in the history
See #4, this should at a later point port the complete Seekers doc pdf to the wiki with all classes and methods. This is a test to give an example.
  • Loading branch information
Supergecki committed May 21, 2024
1 parent 320f639 commit 2d3d927
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/more-resources/classes-in-detail/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: page
title: Classes in detail
nav_order: 1
has_children: true
---

# Classes in detail
34 changes: 34 additions & 0 deletions docs/more-resources/classes-in-detail/vector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
layout: page
title: Vector
parent: Classes in detail
nav_order: 1
---

# Vector

Vector objects in Seekers are used to represent positions or velocities. All angles are given in radians.

## Properties

```x``` (float)

x component of the vector.

```y``` (float)

y component of the vector.

## Methods

``copy()`` $\rightarrow$ Vector

Returns a copy of the vector.

``dot(other: Vector)`` $\rightarrow$ float

Returns the scalar product with another vector.

``static from_polar(angle: float, radius: float)`` $\rightarrow$ Vector

Initializes a new vector from polar coordinates.

0 comments on commit 2d3d927

Please sign in to comment.