Skip to content

Commit 0d640ec

Browse files
committed
(#1) Update docstring of transportation
1 parent 85e973d commit 0d640ec

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/transportation.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,17 +125,18 @@ end
125125
126126
# Arguments
127127
128-
- `a::TransportationProblem`: The problem in type of TransportationProblem
128+
- `t::TransportationProblem`: The problem in type of TransportationProblem
129+
- `initial::TransportationResult`: The initial solution of the transportation problem (optional). The default is `NoInitial`.
129130
130131
# Output
132+
131133
- `TransportationResult`: The custom data type that holds problem, solution, and optimum cost.
132-
- `initial::TransportationResult`: The initial solution of the transportation problem (optional).
133134
134135
# Description
135136
136137
Solves a transportation problem given by an object of in type `TransportationProblem`.
137138
138-
initial is used to store the initial solution of the transportation problem. Any custom
139+
`initial`` is used to store the initial solution of the transportation problem. Any custom
139140
implementation should take a `TransportationProblem` and return a `TransportationResult` object.
140141
Currently, `northwestcorner` and `leastcost` are implemented as custom initial solutions.
141142

0 commit comments

Comments
 (0)