scientific-python-lectures icon indicating copy to clipboard operation
scientific-python-lectures copied to clipboard

Documenting Make file

Open MartinHeroux opened this issue 10 years ago • 2 comments

Disclaimer. I am sorry if this is not the right location for such a request.

Context. The material is very useful and informative, and I especially like the way you generate a pdf document of all the content. As someone starting out with python, git and make, creating this type of pdf shows another great benefit of this type of work flow.

Issue. At some point would it be possible to add some documentation to the make file. I sort of follow the code, but some additional documentation would help users of the code possibly be able to use a similar approach on their own projects.

Cheers,

Marty

MartinHeroux avatar Jun 26 '15 21:06 MartinHeroux

Thank you

 On Saturday, June 27, 2015 12:28 AM, Martin Heroux <[email protected]> wrote:

Disclaimer. I am sorry if this is not the right location for such a request. Context. The material is very useful and informative, and I especially like the way you generate a pdf document of all the content. As someone starting out with python, git and make, creating this type of pdf shows another great benefit of this type of work flow.Issue. At some point would it be possible to add some documentation to the make file. I sort of follow the code, but some additional documentation would help users of the code possibly be able to use a similar approach on their own projects. Cheers,Marty— Reply to this email directly or view it on GitHub.

burcugrbz avatar Jun 27 '15 12:06 burcugrbz

The Makefile could, for example, be documented with in-file comments or a separate markdown file, like Readme.md.

jrjohansson avatar Jun 28 '15 14:06 jrjohansson