search

UBC-MDS / DSCI522_group315

MIT License
0 stars 3 forks source link

Need to better document ChromeDriver issues #29

Closed ksedivyhaley closed 4 years ago

ksedivyhaley commented 4 years ago

Note that you may encounter issues with scripts 3 and 4 which write plots to the analysis directory. If errors are encountered please check:

  • Chrome of Firefox is installed on your machine
  • conda install selenium (or pip install selenium) (check for updates as well)
  • brew cask install chromedriver (or brew cask upgrade chromedriver)

brew cask appears to be a mac command.

I also had to set my path variable manually to the folder where the ChromeDriver was downloaded.

Explain how to do this.

If this is a likely usage problem then you need clearer instructions for dealing with it.

_Originally posted by @ksedivyhaley in https://github.com/UBC-MDS/DSCI522_group315/issues/17#issuecomment-579971728_

SamEdwardes commented 4 years ago

Thanks for the feedback Kate. I wonder if this useful to really document though? Next week we will be "dockerizing" everything which will probably open up a new host of issues. I would rather spend time clearly documenting any issues that come up with that.

What are your thoughts?

ksedivyhaley commented 4 years ago

For the purposes of the next Milestones, you can focus on the other improvements and on making sure that the dockerizing works well and is properly documented.

However, to give you an idea of how important this sort of documentation is for future work, I have still not been able to run these scripts because I was not able to fix the issue with ChromeDriver within the time allotted to mark your assignment.

It's great that you were aware of the possible issue and that you warned the user ahead of time - but without good instructions for fixing the problem, they're likely to hit a wall and be unable to reproduce your analysis! Linking to an issue is better than nothing, but because issues are used for back and forth communication, they aren't always structured in a way that makes it easy to figure out the steps required to fix the problem.

SamEdwardes commented 4 years ago

OK thank you for the response Kate!

On Jan 30, 2020, at 11:33 AM, ksedivyhaley notifications@github.com wrote:

For the purposes of the next Milestones, you can focus on the other improvements and on making sure that the dockerizing works well and is properly documented.

However, to give you an idea of how important this sort of documentation is for future work, I have still not been able to run these scripts because I was not able to fix the issue with ChromeDriver within the time allotted to mark your assignment.

It's great that you were aware of the possible issue and that you warned the user ahead of time - but without good instructions for fixing the problem, they're likely to hit a wall and be unable to reproduce your analysis! Linking to an issue is better than nothing, but because issues are used for back and forth communication, they aren't always structured in a way that makes it easy to figure out the steps required to fix the problem.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/UBC-MDS/DSCI522_group315/issues/29?email_source=notifications&email_token=AELHJ5NN4OKDNTHQT4JVI5DRAMTPPA5CNFSM4KNL5NMKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEKMHPCA#issuecomment-580417416, or unsubscribe https://github.com/notifications/unsubscribe-auth/AELHJ5PWSLE3KAQLH7TCP3TRAMTPPANCNFSM4KNL5NMA.

SamEdwardes commented 4 years ago

Most feedback has been implemented under v3.0