search

syasini / AstroPaint

A python package for creating mock maps of astrophysical signals from a halo catalog
MIT License
46 stars 13 forks source link

example name change #82

Closed AshKelly closed 4 years ago

AshKelly commented 4 years ago

I tried to follow some of the examples from the docs (https://astropaint.readthedocs.io/en/master/)

catalog = Catalog("websky_lite_redshift")

leads to an error that websky_lite_redshift.csv does not exist. I assume it has been replaced by WebSky_2x2.csv or WebSky_lite.csv.

syasini commented 4 years ago

Yes! That's exactly right. Thanks for noticing the mistake. I'll fix this momentarily.

syasini commented 4 years ago

The catalog's name has been fixed on the develop branch. You can check the README and the readthedocs.

I'll merge this into master as soon as you confirm.

AshKelly commented 4 years ago

That's great - thanks! Other libraries I'm involved with have abstracted their examples such that they also become tests. This is quite useful when the codebase is fluid and API's change often.

I'm not suggesting you do this; however, just a thought going forward if the examples keep changing.

syasini commented 4 years ago

That's a great suggestion! I should definitely add some sort of integration testing to make sure the code can run simple examples on new releases. Thanks for pointing it out.