(#2) Fix indentations in docstrings

Author: jbytecode

src/assignment.jl

@@ -14,7 +14,7 @@ import ..OperationsResearchModels: solve, isbalanced, balance
 """
     AssignmentProblem
 
-# Arguments
+# Fields
 
 - `costs::Matrix{T}`: The cost matrix of the assignment problem.
 
@@ -31,9 +31,9 @@ end
 
 
 """
-    AssignmentResult(problem, solution, cost) 
+    AssignmentResult
 
-# Arguments
+# Fields
 
 - `problem::AssignmentProblem`: The original assignment problem.
 - `solution::Matrix`: The solution matrix of the assignment problem.

src/cpm.jl

@@ -19,7 +19,7 @@ export PertResult
 
 The object that represents an activity in CPM (Critical Path Method).
 
-# Arguments 
+# Fields 
 - `name::String`: The name of the activity.
 - `time::Float64`: The time of the activity.
 - `dependencies`: The dependencies of the activity in type of `Vector{CpmActivity}`.
@@ -41,8 +41,9 @@ struct CpmActivity
     dependencies::Vector{CpmActivity}
 end
 
+
 """
-    CpmProblem
+    CpmProblem(activities::Vector{CpmActivity})
 
 # Description
 
@@ -59,7 +60,7 @@ end
 
 
 """
-    CpmResult 
+    CpmResult(pathstr::Vector{String}, path::Vector{CpmActivity})
 
 # Description 
 
@@ -86,7 +87,7 @@ end
 
 The object that represents an activity in PERT (Program Evaluation and Review Technique).
 
-# Arguments
+# Fields
 - `name::String`: The name of the activity.
 - `o::Float64`: The optimistic time of the activity.
 - `m::Float64`: The most likely time of the activity.
@@ -112,7 +113,7 @@ end
 
 
 """
-    PertProblem 
+    PertProblem(activities::Vector{PertActivity})
 
 # Description 
 
@@ -129,7 +130,7 @@ end
 
 
 """
-    PertResult 
+    PertResult(path::Vector{PertActivity}, mean::Float64, stddev::Float64)
 
 # Description 
 
@@ -198,6 +199,7 @@ function pathtostring(activities::Vector{CpmActivity})::Vector{String}
     return reverse(v)
 end
 
+
 """
     solve(problem)
 
@@ -306,7 +308,11 @@ end
 
 - `problem::PertProblem`: The problem in type of PertProblem.
 
-# Example 
+# Output
+
+- `::PertResult`: The object holds the results
+
+# Example
 
 ```julia
 julia> A = PertActivity("A", 1, 2, 3)

src/game.jl

@@ -44,7 +44,7 @@ end
 """
     solve(p::GameProblem; verbose::Bool = false)::Vector{GameResult}
 
-    Solves a zero-sum game using the simplex method.
+Solves a zero-sum game using the simplex method.
 
 # Arguments
 

src/mst.jl

@@ -14,7 +14,8 @@ export MstProblem
     MstProblem 
 
 # Description
-    Defines the minimum spanning tree problem.
+
+Defines the minimum spanning tree problem.
 
 # Fields
 - `connections::Vector{Connection}`: The connections (edges) in the network. 
@@ -33,7 +34,8 @@ end
     MstResult
 
 # Description
-    A structure to hold the result of the minimum spanning tree problem.
+
+A structure to hold the result of the minimum spanning tree problem.
 
 # Fields
 - `connections::Vector{Connection}`: The connections (edges) in the minimum spanning tree.
@@ -122,14 +124,14 @@ end
 """
     solve(problem::MstProblem)
 
-# Arguments 
-
-- `problem::MstProblem`: The problem in type of MstProblem
-
 # Description
 
 Obtains the minimum spanning tree. 
 
+# Arguments 
+
+- `problem::MstProblem`: The problem in type of MstProblem
+
 # Output 
 
 - `::MstResult`: A MstResult object that holds the results. 

src/pmedian.jl

@@ -39,15 +39,16 @@ end
 
     pmedian(data, ncenters)
 
-# Arguments 
-
-- `data::Matrix`: Coordinates of locations 
-- `ncenters::Int`: Number of centers 
-
 # Description
 
 The function calculates Euclidean distances between all possible rows of the matrix data. 
-`ncenters` locations are then selected that minimizes the total distances to the nearest rows. 
+`ncenters` locations are then selected that minimizes the total distances to the nearest rows.
+
+
+# Arguments 
+
+- `data::Matrix`: Coordinates of locations 
+- `ncenters::Int`: Number of centers  
 
 # Output 
 
@@ -100,14 +101,15 @@ end
 
     pmedian_with_distances(distancematrix, ncenters)
 
+# Description
+
+`ncenters` locations are selected that minimizes the total distances to the nearest rows. 
+
 # Arguments 
+
 - `distancematrix::Matrix`: n x n matrix of distances
 - `ncenters::Int`: Number of centers 
 
-# Description
-
-- `ncenters` locations are selected that minimizes the total distances to the nearest rows. 
-
 # Output 
 - `PMedianResult`: PMedianResult object. 
 """

src/shortestpath.jl

@@ -89,6 +89,15 @@ julia> result.path
 julia> result.cost
 8.0
 ```
+
+# NOTE 
+
+    In this function it's assumed that the problem has a unique start and finish node.
+    A heuristic approach is used to find the start and finish nodes. If a node has only
+    outcoming connections, it is considered the start node. If a node has only incoming connections,
+    it is considered the finish node. Of course a network can have multiple start and finish nodes,
+    but this heuristic simplifies the problem. Future implementations could explore more complex
+    scenarios with multiple start and finish nodes. 
 """
 function solve(problem::ShortestPathProblem)
 

src/simplex.jl

@@ -417,8 +417,8 @@ end
 
 # Description 
 
-    Solves the given SimplexProblem using the Simplex algorithm. The `solve!` function 
-    modifies the input SimplexProblem in place.
+Solves the given SimplexProblem using the Simplex algorithm. The `solve!` function 
+modifies the input SimplexProblem in place.
 
 # Arguments
 
@@ -446,8 +446,8 @@ end
 
 # Description 
 
-    This function performs the Simplex iterations on the given SimplexProblem and returns the 
-    history of SimplexProblem states.
+This function performs the Simplex iterations on the given SimplexProblem and returns the 
+history of SimplexProblem states.
 
 # Arguments
 
@@ -520,7 +520,7 @@ end
 
 # Description
 
-    This function creates a SimplexProblem object from the given parameters. 
+This function creates a SimplexProblem object from the given parameters. 
 
 # Arguments
 
@@ -532,7 +532,7 @@ end
 
 # Returns
 
-    A SimplexProblem object.
+A SimplexProblem object.
 
 # Example
 
@@ -585,7 +585,7 @@ end
 
 # Description
 
-    Attaches an Identity matrix to the right of the given matrix A and applies the Gauss-Jordan elimination method to find the inverse of the given matrix.
+Attaches an Identity matrix to the right of the given matrix A and applies the Gauss-Jordan elimination method to find the inverse of the given matrix.
 
 # Arguments
 
@@ -594,7 +594,7 @@ end
 
 # Returns
 
-    The inverse of the given matrix.
+The inverse of the given matrix.
 
 # Example
 

src/transportation.jl

@@ -17,7 +17,7 @@ import ..OperationsResearchModels: solve, balance, isbalanced
 """
     TransportationProblem
 
-# Arguments
+# Fields
 
 - `costs::Matrix{T}`: The cost matrix of the transportation problem.
 - `demand::Vector{T}`: The demand vector of the transportation problem.
@@ -37,7 +37,7 @@ end
 """
     TransportationResult(problem, balancedProblem, solution, cost)
 
-# Arguments
+# Fields
 
 - `problem::TransportationProblem`: The original transportation problem.
 - `balancedProblem::TransportationProblem`: The balanced transportation problem.

src/travelingsalesman.jl

@@ -13,7 +13,8 @@ export TravelingSalesmanResult
     TravelingSalesmanProblem
 
 # Description
-    A data structure to hold the problem definition of the traveling salesman problem.
+
+A data structure to hold the problem definition of the traveling salesman problem.
 
 # Fields
 
@@ -30,7 +31,8 @@ end
     TravelingSalesmanResult
 
 # Description
-    A data structure to hold the result of the traveling salesman problem.
+
+A data structure to hold the result of the traveling salesman problem.
 
 # Fields
 - `route::Vector{Int}`: The best route found.