-
Notifications
You must be signed in to change notification settings - Fork 42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update and add more docs #145
Conversation
0799436
to
eca8d62
Compare
Codecov Report
@@ Coverage Diff @@
## master #145 +/- ##
=======================================
Coverage 93.60% 93.60%
=======================================
Files 2 2
Lines 250 250
=======================================
Hits 234 234
Misses 16 16
Continue to review full report at Codecov.
|
The main page that describes the usage seems to use the earlier notation of |
When jldoctest fails, it uses the actual output instead of the reference output; this in the docs will be updated automatically when Julia 1.6 is out 😃 |
The docstring for |
There was a Documenter bug that if you run |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
198bb72
to
e20c45d
Compare
The docs are rewritten a bit to better demonstrate how this package is used with so many new features @jishnub have added.
The docs are updated using julia 1.6-DEV, so there're jldoctest warnings if you check the logs. Most of them are
Matrix{Int64}
<==>Array{Int64, 2}
things.preview: https://juliaarrays.github.io/OffsetArrays.jl/previews/PR145/
The workaround to conditional push preview requires github action as the CI platform, so I switched from travis to github action for docs deployment.