Develop a Table of Contents #5

Activity

1. arm61

   added

   help wantedExtra attention is neededExtra attention is needed

   on Mar 20, 2020
2. acnash commented on Mar 20, 2020

   

   acnash

   on Mar 20, 2020

   Last edited by arm61

   More actions

   Having just finished some consulting for a small science startup who are using Python, I would definitely cover coding style. For example some very simple idea:

   • variable names reflect the expected datatype
   • function/method argument names reflect the datatype
   • return variable names reflect the datatype

   You ought to be able to read the function/method header and understand what it is, and what it expects and then you should be able to know what to respect in return by looking at the return statement.
3. j-m-dean commented on Mar 20, 2020

   

   j-m-dean

   on Mar 20, 2020

   Contributor

   More actions

   Some initial suggestions are:

   • A basic notation and operations section in the basics section ie explain: !=, == v =, <=, remainder division, integer division, normal division, multiplication. So the very basic building blocks.
   • subtitle change from and _or to Boolean logic. So just and/or/not
   • a brief introduction to linear algebra in the data_work section. Many chemists go through their degrees avoiding matrices and vectors but I think if students are coding they could get some benefit from some exposure.
   • it would not be that big of a jump from surface plots to make a gif from time dependant data.
4. arm61 commented on Mar 20, 2020

   

   arm61

   on Mar 20, 2020

   ContributorAuthor

   More actions

   @acnash I have added a mention to your comment in #13 which relates to the Documentation section. Thanks for the idea.

   @j-m-dean:

   • I think this first point is covered in Types but happy to here more suggestions on how to improve that section.
   • Same as above I think...
   • I like this idea and have added it to the TOC as of Toc update #27 and there is an open issue (Linear algebra #26) related to writing it.
   • I have referenced this comment in Surface plots  #21