rafaqz / DimensionalData.jl

Named dimensions and indexing for julia arrays and other data
https://rafaqz.github.io/DimensionalData.jl/stable/
MIT License
271 stars 38 forks source link

Build docs on latest Julia release #463

Closed sethaxen closed 1 year ago

sethaxen commented 1 year ago

Currently the docs are being built on the LTS. This PR changes to build the docs for the latest Julia release.

codecov-commenter commented 1 year ago

Codecov Report

Merging #463 (9d8799e) into main (11be8da) will not change coverage. The diff coverage is n/a.

:exclamation: Current head 9d8799e differs from pull request most recent head a1606ce. Consider uploading reports for the commit a1606ce to get more accurate results

@@           Coverage Diff           @@
##             main     #463   +/-   ##
=======================================
  Coverage   89.46%   89.46%           
=======================================
  Files          37       37           
  Lines        2601     2601           
=======================================
  Hits         2327     2327           
  Misses        274      274           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

rafaqz commented 1 year ago

Should we do both?

sethaxen commented 1 year ago

Is that possible? I've never seen it. I don't think it's necessary though. It would be better to add admonitions indicating when a method is only available for certain Julia versions or when behavior changes between versions.

rafaqz commented 1 year ago

You can just add another line with - 1 instead of replacing - 1.6, and it will run both.

Its good to test 1.6 for use cases where people are stuck with LTS. They do exist. And we should check for LTS compatible syntax. When NamedTuple destructing (or maybe it was keywords without =) came in I broke the previous LTS in some of my packages by mistake, because the new syntax is nice and you want to used it.

sethaxen commented 1 year ago

Ah, I thought you were asking whether we should deploy docs on both LTS and latest release. Sure, we can build docs on both. I'll just need to add a way to disable deployment for v1.6, because otherwise one will overwrite the other.

rafaqz commented 1 year ago

Ahh yeah that makes sense, I also didn't totally think through what I was saying with deployment of both docs. Actually having two versions will break the docstests because the show output changes.

But building on 1.6 and leaving it there was a conscious choice to force the docs to work on LTS - which means they also work on 1.9. The other way around means they will work on 1.9 but may not work on 1.6.

I chose the conservative option where the docs are less likely to be wrong for any users. But the tradeoff to use the latest syntax may also be valid.

rafaqz commented 1 year ago

Ok I'm sold after trying to build docs in the other PR...