(#2) Add documentation about to heuristics used in determining the start and finish nodes

Author: jbytecode

src/maximumflow.jl

@@ -55,6 +55,10 @@ end
 
     solve(problem)
 
+# Description 
+
+Solves a maximum flow problem given by an object of in type `MaximumFlowProblem`.
+
 # Arguments
 
 - `problem::MaximumFlowProblem`: The problem in type of MaximumFlowProblem

src/mst.jl

@@ -20,7 +20,7 @@ Defines the minimum spanning tree problem.
 # Fields
 - `connections::Vector{Connection}`: The connections (edges) in the network. 
 
-# Note 
+!!! info "Interpreting the Connection object"
 
     The Connection object defines a directed edge, but for the minimum spanning tree problem, 
     the edges are considered undirected.

src/shortestpath.jl

@@ -90,7 +90,7 @@ julia> result.cost
 8.0
 ```
 
-# NOTE 
+!!! info "Determining start and finish nodes"
 
     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