Skip to content
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

Merged
merged 3 commits into from
Sep 14, 2020
Merged

update and add more docs #145

merged 3 commits into from
Sep 14, 2020

Conversation

johnnychen94
Copy link
Member

@johnnychen94 johnnychen94 commented Sep 14, 2020

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.

@codecov
Copy link

codecov bot commented Sep 14, 2020

Codecov Report

Merging #145 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #145   +/-   ##
=======================================
  Coverage   93.60%   93.60%           
=======================================
  Files           2        2           
  Lines         250      250           
=======================================
  Hits          234      234           
  Misses         16       16           
Impacted Files Coverage Δ
src/OffsetArrays.jl 94.17% <ø> (ø)
src/axes.jl 90.90% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b2fd31a...e20c45d. Read the comment docs.

@jishnub
Copy link
Member

jishnub commented Sep 14, 2020

The main page that describes the usage seems to use the earlier notation of Array{Float64,2}, whereas the developer page has now been updated to use Matrix{Float64}. Perhaps these should be consistent?

@johnnychen94
Copy link
Member Author

johnnychen94 commented Sep 14, 2020

The main page that describes the usage seems to use the earlier notation of Array{Float64,2}, whereas the developer page has now been updated to use Matrix{Float64}.

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 😃

@jishnub
Copy link
Member

jishnub commented Sep 14, 2020

The docstring for IdOffsetRange needs to be updated, this triggered a build error in the docs

@johnnychen94
Copy link
Member Author

There was a Documenter bug that if you run doctest multiple times, it simply gets skipped without warnings.

JuliaDocs/Documenter.jl#974

Copy link
Member

@jishnub jishnub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants