smiths / caseStudies

Case studies of (manual) documentation for scientific computing software
3 stars 2 forks source link

SolarHeatingWaterOnly: Correct Comments in Python #87

Closed samm82 closed 6 years ago

samm82 commented 6 years ago

In Python, comments are denoted by #comment, not by """comment""". Yes triple quotes can act as comments, but they actually create a multi-line string that is garbage collected if not used (ie. assigned to a variable, etc.). Depending on their placement, they can actually mess up the code. Comments throughout the Python Implementation in SolarHeatingWaterOnly should be replaced to reflect this, simply to follow convention if not to avoid errors.

86

smiths commented 6 years ago

Please don't assign this to me. Assign it to the owner (summer student) for the case study. In this case, I believe it is @elwazana

elwazana commented 6 years ago

@samm82 @smiths There are no occurrences of """comment""" in the SolarWaterHeatingOnly example

smiths commented 6 years ago

Thank you for the investigation @elwazana.