search

QuantEcon / SimpleDifferentialOperators.jl

Library for simple upwind finite differences
MIT License
12 stars 2 forks source link

Notebooks TOML #128

Closed arnavs closed 5 years ago

arnavs commented 5 years ago

I believe this is all that's required to update the notebooks to the new InstantiateFromURL scheme going forward. tl;dr Add SimpleDifferentialOperators.jl to the docs/examples/{Project, Manifest}.toml, and keep track of the versions using the Manifest there.

Will merge this once the new release of Instantiate gets approved, and I can test it in full.

codecov-io commented 5 years ago

Codecov Report

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

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #128   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           4      4           
  Lines         108    108           
=====================================
  Hits          108    108

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 a05b7ec...879afb9. Read the comment docs.

arnavs commented 5 years ago

The one drawback of this kind of approach (@jlperla) is that it makes it impossible for the dev notebooks to use the actual master branch (because they're relying on TOML to be reproducible, but master isn't a tagged version.)

Maybe the solution is to stop showing those docs, once this package is in a somewhat stable state.

jlperla commented 5 years ago

But isn't that why you publish it with the version tag on the notebook?

arnavs commented 5 years ago

Right. To be clear, this approach will work for all of our stable docs (i.e., the static tags.) But it won't work for master, because it's impossible to get that cleanly into Manifest.toml without a tagged release.

arnavs commented 5 years ago

This discussion is complicated by the fact that there's the master set of TOML files (which we can always pull), and the master state of the actual SDO package (which we can't include in a Manifest file.)

Anyways, we can talk more when we meet this morning.

jlperla commented 5 years ago

@arnavs What is the status of this? Should we merge and test prior to a new tag?