computablee / DotMP

A collection of powerful abstractions for parallel programming in .NET with an OpenMP-like API.
https://computablee.github.io/DotMP/
GNU Lesser General Public License v2.1
29 stars 7 forks source link

Documentation #5

Closed computablee closed 1 year ago

computablee commented 2 years ago

OpenMP.NET is notably lacking in documentation. There are a few ways you can help improve this:

  1. Editing README.md to include a small tutorial + example code.
  2. Adding XML-style comments to classes and methods describing the parameters, return value, and behavior.
  3. A wiki would be nice, but not necessary. That's a lot of work.

There's a lot of work needed. Any help is appreciated.

jotasprout commented 2 years ago

I would love to do this. Please assign it to me.

computablee commented 2 years ago

I would love to do this. Please assign it to me.

Done! Thank you very much!

jotasprout commented 2 years ago

Sorry, first day of new job was super long and I haven't started yet but am still committed.

computablee commented 1 year ago

I've written a decent readme explaining all of the available functions and datatypes, but we could still use code comments and a wiki. Hopefully when the next hacktoberfest comes around the project will be in a better spot to accept contributions.

computablee commented 1 year ago

17 addresses a mountain of documentation within the actual codebase.

computablee commented 1 year ago

Closing this with #18 and #19, as these largely address the severe documentation issues. More in-function comments are appreciated, but the vast majority of necessary documentation is now addressed.