Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Unified documentation in DataAV. #199

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Unified documentation in DataAV. #199

wants to merge 1 commit into from

Conversation

dominikmaeckel
Copy link
Member

No description provided.

@dominikmaeckel dominikmaeckel added documentation Improvements or additions to documentation clean-up Something is out of date and should be removed labels Dec 11, 2024
@dominikmaeckel dominikmaeckel self-assigned this Dec 11, 2024
@dominikmaeckel dominikmaeckel linked an issue Dec 11, 2024 that may be closed by this pull request
Unify documentation in DataAV #198
Open
@dominikmaeckel dominikmaeckel enabled auto-merge (squash) December 11, 2024 09:53
github-advanced-security[bot]
github-advanced-security bot found potential problems Dec 11, 2024
View reviewed changes
stars-data-av/src/main/kotlin/tools/aqua/stars/data/av/dataclasses/Vector3D.kt
@@ -53,4 +55,10 @@
x = this.x / scalar.toDouble(),
y = this.y / scalar.toDouble(),
z = this.z / scalar.toDouble())

fun dot(other: Vector3D): Double = x * other.x + y * other.y + z * other.z

Check warning

Code scanning / detekt

Public functions require documentation. Warning

The function dot is missing documentation.
stars-data-av/src/main/kotlin/tools/aqua/stars/data/av/dataclasses/Vector3D.kt

fun dot(other: Vector3D): Double = x * other.x + y * other.y + z * other.z

fun magnitude(): Double = sqrt(x * x + y * y + z * z)

Check warning

Code scanning / detekt

Public functions require documentation. Warning

The function magnitude is missing documentation.
stars-data-av/src/main/kotlin/tools/aqua/stars/data/av/dataclasses/Vector3D.kt

fun magnitude(): Double = sqrt(x * x + y * y + z * z)

fun normalize(): Vector3D = magnitude().let { Vector3D(x / it, y / it, z / it) }

Check warning

Code scanning / detekt

Public functions require documentation. Warning

The function normalize is missing documentation.
tillschallau
tillschallau requested changes Dec 11, 2024
View reviewed changes
Copy link
Member

@tillschallau tillschallau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should tackle the missing documentation comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tillschallau tillschallau tillschallau requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@dominikmaeckel dominikmaeckel

Labels
clean-up Something is out of date and should be removed documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Unify documentation in DataAV
2 participants
@dominikmaeckel @tillschallau