[JOSS review] Minor comments about examples in the docs.

[JDonaldM]

Review thread.

I haven't looked at at all of the examples in the docs yet but the ones I have looked at have been really nice and give a good overview of what you can do with the code!

I did want to note that in a few cases the code blocks cannot be run in the order they are presented without a couple of tweaks. For example:

• The analysis tools examples rely on the user to have read the getting started example first and realise that the 'The example data will be the Schecter function example' refers to this. In the same example the cross check plot uses matplotlib but it isn't imported in any of the previous code blocks, also the parameter sweep plot calls schecter_emulator which isn't defined in this example.
• In the experimental design example the final code block throws an error because of string formatting. It might also be good to link to eagle_25.yml, it wasn't immediately clear to me where to find this file.
• In the loading SWIFT data example files and value_files in the first code block are undefined, along with filenames in the third code block.

[Moyoxkit]

Hello @JDonaldM

Thanks for the comments! It is indeed much nicer to have each page be self-consistent. I've implemented updates to these sections here: https://github.com/SWIFTSIM/emulator/pull/35 We'll merge the changes to the master once https://github.com/SWIFTSIM/emulator/issues/22 is also fixed.

[Moyoxkit]

Have now been resolved with #35 and #36