smiths / caseStudies

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

Created implementations for the designs discussed. #250

Closed B-rando1 closed 4 months ago

B-rando1 commented 4 months ago

In order to help answer some of the questions raised here, I implemented the designs I listed here.

smiths commented 4 months ago

Having concrete code is a great way to see the different design options. We can definitely merge this into the case studies repo.

balacij commented 4 months ago

Are we okay to delete the branch?

smiths commented 4 months ago

Good question @balacij. @B-rando1 will you be doing any further development in this branch?

B-rando1 commented 4 months ago

That's a good question @smiths. Since there's likely to be some discussion on the designs here, there might be changes that need to be made. I could set a reminder for after our Monday meeting to delete the branch if I'm not using it, does that sound good?

smiths commented 4 months ago

Sounds good, as long as you remember. :smile: Historically, we have had a bad habit of letting branches go unpruned. :smile:

JacquesCarette commented 4 months ago

I fully intend to comment on the design. I've read it (it is nice and detailed) but commenting isn't a 2 minute job, so has to wait its turn in my priority queue.