Document gotchas when interoperation with python

[jw3126]

#785

[jw3126]

We could add PyCall as a test dependency and turn this into a doctest. However it might be fragile since we need to install h5py.

[musm]

Is possible to use Conda.jl to install the hdf5 library in order to turn these to doctests. I'm not opposed to adding a PyCall test dependency. In general, it does seem to be a good idea to ensure inter-op.

[jw3126]

We could, but this introduces further headaches. If you run tests locally using e.g. system python things may fail.

[jw3126]

I added this anyway.

[jw3126]

@musm https://github.com/JuliaIO/HDF5.jl/pull/804/checks?check_run_id=1708414939#step:4:115 any ideas?

[jw3126]

BTW is it intended, that CI passes, despite the doctest fail?

[musm]

BTW is it intended, that CI passes, despite the doctest fail?

It shouldn't, not sure why it passed yet.

[musm]

I'm trying to decide if we should add Literate as a test dependency. What was the specific reason before the last commit that spawned you to switch over to use Literate?

[jw3126]

I'm trying to decide if we should add Literate as a test dependency. What was the specific reason before the last commit that spawned you to switch over to use Literate?

The only reason is, that I find it easier to develop a .jl document, which is executable Julia code, instead of a .md document that I can only run doctests on. I removed the Literate dependency.

[jw3126]

@musm https://github.com/JuliaIO/HDF5.jl/runs/1762155054?check_suite_focus=true#step:4:112 ideas? I cannot reproduce this error locally.

[musm]

Let's try running thing again here