documentation for threads and tasks needs improving
Nobody has claimed this yet.
- Dominant language
- Macaulay2
- Stars
- 435
- Forks
- 297
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 11
Description
The documentation for the following should all refer to each other.
* Task
* "parallel programming with threads and tasks"
* schedule
* createTask
* addCancelTask
* addDependencyTask
* addStartTask
* cancelTask
* isCanceled (change name!?)
* taskResult
* isReady
* nanosleep
* allowableThreads
* maxAllowableThreads
It would also be useful to have a few examples of higher level use of these low level facilities. I believe we used to have something like this, (perhaps even in the Goettingen workshop from a number of years ago?).
This is part of the effort to make task more usable in Macaulay2.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation entries for Task, “parallel programming with threads and tasks,” schedule, the task functions, nanosleep, allowableThreads, and maxAllowableThreads. Read how these entries are organized and identify any existing workshop or higher-level examples. Done means the entries refer to one another consistently and include useful higher-level examples for making tasks usable in Macaulay2.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100