Skip to content

Update plotting documentation and function comments #7

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.

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

Merged
merged 1 commit into from
Jul 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,22 @@

This package provides a collection of functions for linear algebra operations and transformations.

## Linear Algebra Functions
## Basic Linear Algebra Functions

This section provides the documentation for all the linear algebra functions.
This section provides the documentation for the basic linear algebra functions.

```@autodocs
Modules = [Linear_Algebra]
Order = [:function, :type]
Pages = ["linear_algebra_basic.jl", "linear_algebra_transform.jl"]
```
Pages = ["linear_algebra_basic.jl"]
```

## Linear Transformations

This section provides the documentation for linear transformations and related operations.

```@autodocs
Modules = [Linear_Algebra]
Order = [:function, :type]
Pages = [""linear_algebra_transform.jl"]
```
5 changes: 3 additions & 2 deletions src/Linear_Algebra.jl
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ end
# Exports...
# Pure computational functions (no plotting dependencies)
export calculate_param_line
# Integrated plotting functions (computation + visualization)
export distance_2_points, center_of_gravity, barycentric_coord, plot_param_line
export distance_2_points, center_of_gravity, barycentric_coord
export vector_angle_cos, is_orthogonal, polar_unit, orthproj, reflection, rotation
export point_in_implicit_line, parametric_to_implicit_line, implicit_to_parametric_line, explicit_line
export distance_to_implicit_line, implicit_line_point_normal_form, distance_to_pnf_implicit_line
Expand All @@ -26,6 +25,8 @@ export projection_matrix_symbolic, projection_matrix_symbolic_polar, projection_
export projection_matrix_transpose, rotation_matrix_symbolic, rotation_matrix, rotation_matrix_ns
export stretch_matrix_symbolic, stretch_matrix
export reflection_matrix_symbolic, reflection_matrix, reflection_matrix_rational
# Integrated plotting functions (computation + visualization)
export plot_param_line

# Re-export the @variables macro
eval(:(export @variables))
Expand Down
1 change: 0 additions & 1 deletion src/linear_algebra_basic.jl
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ end
plot_param_line(p::Point, q::Point, n::Int64) → [Point]
Creates `n` points on a line defined by `p` and `q`, using the parametric equation of a line, then plot
"""

function plot_param_line(p::Point, q::Point, n::Int64)
# Use computational function for calculations
Ps = calculate_param_line(p, q, n)
Expand Down
Loading