search

grd349 / PBjam

A repo for our peak baggin code and tips on jam
MIT License
17 stars 6 forks source link

Examples: remove mydir for ./ #148

Closed grd349 closed 5 years ago

grd349 commented 5 years ago

I keep running the examples and forgetting to change ./mydir to ./ and the code breaks because ./mydir does not exist. We need to fix this ASAP. It's a pain to run the code only to faile because the dir does not exist.

Do we,

  1. Change mydir to ./ in the examples.
  2. Add directory creation if directory does not exist.
  3. Both of the above.

I reckon 3. - thoughts from the team ...

ojhall94 commented 5 years ago

3! Directory creation is always safest imo

nielsenmb commented 5 years ago

Sure, we can do that.

The notebooks in docs where never meant to be run though. Since they are the ones that are show on readthedocs. They're meant to be read-only, so that they don't disappear if there's a typo in the ipynb.

The ones you can play around with are in the Examples directory.

On Fri, 26 Jul 2019, 10:00 Oliver Hall, notifications@github.com wrote:

3! Directory creation is always safest imo

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/grd349/PBjam/issues/148?email_source=notifications&email_token=AEJWO374UHTWCPSAGYJ5BGDQBL7N7A5CNFSM4IG7UD7KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD24V44Q#issuecomment-515464818, or mute the thread https://github.com/notifications/unsubscribe-auth/AEJWO37KPG6MBVOV24NDVJDQBL7N7ANCNFSM4IG7UD7A .

grd349 commented 5 years ago

Good point - I didn't think about that.

We need to add text to the Examples :(

We should also do this fix anyway. Perhaps people will follow the example by typing the instructions them selves. It would still be annoying for it to fail.

nielsenmb commented 5 years ago

I think if the user is typing out those examples they should know that they don't have a directory called mydir. It's like the stackoverflow examples, dir=/dir/where/code/is etc. it's pretty obvious that line needs to be changed.

Should put an mkdir line in session/star in case it doesn't exist