include/NEST.hh has no comments

NESTCollaboration / nest

Noble Element Simulation Technique is used to simulate noble-element energy deposition microphysics.

http://nest.physics.ucdavis.edu

Other

23 stars 42 forks source link

include/NEST.hh has no comments #10

Closed tunnell closed 6 years ago

tunnell commented 6 years ago

include/NEST.hh is going to be the first thing that people look at. It has no comments. I really think that unless we do the following, most people will get frustrated:

Paragraph at the top that explains what NEST.cpp/h do
A sentence or two on each function. An explanation of the units and meanings of variables.

mszydagis commented 6 years ago

I don't think a header file is the first thing that people look at. Why would people get frustrated and not use when testNEST executable works just fine and is simpler than Geant4 and I imagine most experiments' existing simulation packages?? I never open up G4 headers to start reading and understanding just for fun, for one.

A sentence or two on each function would be great, and your suggested explanations of variables and units. However, this is a luxury we cannot afford right now. If I worked 24 hours on this the next week I could never finish commenting everything.

tunnell commented 6 years ago

I meant if people are trying to use it as a library in their own code. If you want, I can take a crack at it.

mszydagis commented 6 years ago

I have done it now, so I'm closing. Pull latest master and take a look: Even though I'm closing feel free to improve further building upon my foundation. I know you are new and don't know all the NEST functions yet perhaps, but that is a good thing, right -- fresh eyes. You can point out any particular comment I have you think is totally inadequate before the release, then there's still a tiny bit of time to fix it.

mszydagis commented 6 years ago

Haha, wrong button. CLOSE and comment