Skip to content

Commit e07e6ec

Browse files
authored
Update plotting documentation and function comments (#7)
- Enhanced documentation for plot_param_line and calculate_param_line functions - Updated module documentation in Linear_Algebra.jl - Improved function docstrings for clarity and consistency - Updated docs/src/index.md with plotting-related documentation
1 parent 700740a commit e07e6ec

File tree

3 files changed

+17
-7
lines changed

3 files changed

+17
-7
lines changed

docs/src/index.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,22 @@
22

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

5-
## Linear Algebra Functions
5+
## Basic Linear Algebra Functions
66

7-
This section provides the documentation for all the linear algebra functions.
7+
This section provides the documentation for the basic linear algebra functions.
88

99
```@autodocs
1010
Modules = [Linear_Algebra]
1111
Order = [:function, :type]
12-
Pages = ["linear_algebra_basic.jl", "linear_algebra_transform.jl"]
13-
```
12+
Pages = ["linear_algebra_basic.jl"]
13+
```
14+
15+
## Linear Transformations
16+
17+
This section provides the documentation for linear transformations and related operations.
18+
19+
```@autodocs
20+
Modules = [Linear_Algebra]
21+
Order = [:function, :type]
22+
Pages = [""linear_algebra_transform.jl"]
23+
```

src/Linear_Algebra.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ end
1515
# Exports...
1616
# Pure computational functions (no plotting dependencies)
1717
export calculate_param_line
18-
# Integrated plotting functions (computation + visualization)
19-
export distance_2_points, center_of_gravity, barycentric_coord, plot_param_line
18+
export distance_2_points, center_of_gravity, barycentric_coord
2019
export vector_angle_cos, is_orthogonal, polar_unit, orthproj, reflection, rotation
2120
export point_in_implicit_line, parametric_to_implicit_line, implicit_to_parametric_line, explicit_line
2221
export distance_to_implicit_line, implicit_line_point_normal_form, distance_to_pnf_implicit_line
@@ -26,6 +25,8 @@ export projection_matrix_symbolic, projection_matrix_symbolic_polar, projection_
2625
export projection_matrix_transpose, rotation_matrix_symbolic, rotation_matrix, rotation_matrix_ns
2726
export stretch_matrix_symbolic, stretch_matrix
2827
export reflection_matrix_symbolic, reflection_matrix, reflection_matrix_rational
28+
# Integrated plotting functions (computation + visualization)
29+
export plot_param_line
2930

3031
# Re-export the @variables macro
3132
eval(:(export @variables))

src/linear_algebra_basic.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ end
4545
plot_param_line(p::Point, q::Point, n::Int64) → [Point]
4646
Creates `n` points on a line defined by `p` and `q`, using the parametric equation of a line, then plot
4747
"""
48-
4948
function plot_param_line(p::Point, q::Point, n::Int64)
5049
# Use computational function for calculations
5150
Ps = calculate_param_line(p, q, n)

0 commit comments

Comments
 (0)