search

drivendataorg / cookiecutter-data-science

A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.
https://cookiecutter-data-science.drivendata.org/
MIT License
7.99k stars 2.41k forks source link

Update Makefile help command to work on all platforms #335

Closed chrisjkuch closed 6 months ago

chrisjkuch commented 7 months ago

Closes #221

This PR switches the style and format of the python script in the Makefile that generates the help message text. The old script was not formatted correctly to regex match commented commands written with the structure we use in our Makefile, and leveraged $$VAR syntax in the command itself that does not work in Windows environments.

In order for this to work in the intended way, we had to treat the Python script as a single line - otherwise, because we're invoking the script as a command, newlines would trigger running a new command entirely. That's why the script ends each line with ; \.

render[bot] commented 6 months ago

Your Render PR Server URL is https://cookiecutter-data-science-pr-335.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-cmb34ken7f5s738ji12g.

chrisjkuch commented 6 months ago

@pjbull this is ready for review!