Skip to content

Commit e0fbe1d

Browse files
Fix some docstrings (#95)
Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
1 parent 853acfd commit e0fbe1d

File tree

6 files changed

+10
-11
lines changed

6 files changed

+10
-11
lines changed

src/Project/BackgroundGridAPI.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
"""
3-
addBackgroundGrid(proj::Project, bgSize::Array{Float64})
3+
addBackgroundGrid!(proj::Project, bgSize::Array{Float64})
44
55
Add the background grid block with the grid size to be a 3-vector. Use this when there
66
is an outer boundary defined in the model.

src/Project/CurvesAPI.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ end
315315

316316

317317
"""
318-
setArcUnits(crv::Dict{String,Any}, units::String)
318+
setArcUnits!(crv::Dict{String,Any}, units::String)
319319
320320
Set the units for the start and end angles of a circular arc curve.
321321
"""

src/Project/ModelAPI.jl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -341,13 +341,12 @@ function getChainIndex(chain::Vector{Dict{String, Any}},name)
341341
end
342342
return 0
343343
end
344+
344345
"""
345346
getAllInnerBoundaries(proj::Project)
346347
347348
Returns an array of the inner boundaries
348349
"""
349-
350-
351350
function getAllInnerBoundaries(proj::Project)
352351
innerBndryDict = getDictInModelDictNamed(proj,"INNER_BOUNDARIES")
353352
if haskey(innerBndryDict,"LIST")

src/Project/RefinementRegionsAPI.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ end
403403

404404

405405
"""
406-
getRefinementStart (r::Dict{String,Any})
406+
getRefinementStart(r::Dict{String,Any})
407407
408408
Return Array{Float64} of the start location of the refinement line. `r` is the dictionary that
409409
represents the refinement region.

src/Project/RunParametersAPI.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ end
3737

3838

3939
"""
40-
setName(proj::Project,name::String)
40+
setName!(proj::Project,name::String)
4141
4242
The `name` of the project is the filename to be used by the mesh, plot, and
4343
stats files. It is also the name of the control file the tool will produce.
@@ -63,7 +63,7 @@ end
6363

6464

6565
"""
66-
setPolynomialOrder(proj::Project, p::Int)
66+
setPolynomialOrder!(proj::Project, p::Int)
6767
6868
Set the polynomial order for boundary curves in the mesh file to `p`.
6969
"""
@@ -90,7 +90,7 @@ end
9090

9191

9292
"""
93-
setMeshFileFormat(proj::Project, meshFileFormat::String)
93+
setMeshFileFormat!(proj::Project, meshFileFormat::String)
9494
9595
Set the file format for the mesh file. Acceptable choices
9696
are "ISM", "ISM-V2", or "ABAQUS".
@@ -125,7 +125,7 @@ end
125125

126126

127127
"""
128-
setPlotFileFormat(proj::Project, plotFileFormat::String)
128+
setPlotFileFormat!(proj::Project, plotFileFormat::String)
129129
130130
Set the file format for the plot file. Acceptable choices
131131
are "sem", which includes interior nodes and boundary nodes and "skeleton", which includes

src/Project/SmootherAPI.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ end
2323

2424

2525
"""
26-
setSmoothingStatus(proj:Project, status::String)
26+
setSmoothingStatus!(proj:Project, status::String)
2727
2828
Status is either "ON" or "OFF"
2929
"""
@@ -38,7 +38,7 @@ end
3838

3939

4040
"""
41-
smoothingStatus(proj::Project)
41+
getSmoothingStatus(proj::Project)
4242
4343
Returns whether the smoother will be "ON" or "OFF"
4444
"""

0 commit comments

Comments
 (0)