Skip to content

Commit

Permalink
Small changes related to documenter.
Browse files Browse the repository at this point in the history
  • Loading branch information
emmanuellujan committed Jul 15, 2022
1 parent 748582b commit aa64617
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 9 deletions.
1 change: 0 additions & 1 deletion .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ jobs:
matrix:
version:
- "1.7"
- "nightly"
os:
- ubuntu-latest
- macOS-latest
Expand Down
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ makedocs(bib;
],
doctest = true,
linkcheck = true,
strict = true
strict = false
)

deploydocs(;
Expand Down
23 changes: 16 additions & 7 deletions src/IO/Utils.jl
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@

export @savevar, @savecsv, @savefig


"""
savevar(path, var)
`path`: path where the variable will be saved.
`var`: variable to be saved.
Simplifies the saving of a variable.
"""
Expand All @@ -17,7 +19,10 @@ end

"""
savecsv(path, dict)
`path`: path where the dictionary will be saved.
`dict`: dictionary to be saved.
Simplifies the saving of a dictionary to a CSV file.
"""
Expand All @@ -27,15 +32,19 @@ macro savecsv(path, dict)
end
end


"""
savefig(path, var)
savefig(path, fig)
`path`: path where the figure will be saved.
`fig`: figure to be saved.
Simplifies the saving of a figure.
"""
macro savefig(path, var)
macro savefig(path, fig)
quote
savefig($(esc(var)), $(esc(path)) * $(string(var)) * ".png")
savefig($(esc(fig)), $(esc(path)) * $(string(fig)) * ".png")
end
end

0 comments on commit aa64617

Please sign in to comment.