TimefoldAI / TimefoldAI/timefold-solver
Feat: fix misleading documentation in the design patterns document
@triceo is already working on this.
Since Oct 23, 2023.
- Dominant language
- Java
- Stars
- 1.8k
- Forks
- 228
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 46
Description
sourced from https://github.com/TimefoldAI/timefold-solver/discussions/266#discussioncomment-6986430
I said:
Reading through the design patterns at https://timefold.ai/docs/timefold-solver/latest/design-patterns/design-patterns.html I noticed that using Shift or Employee as a PlanningEntity is not advised
The quickstart still seems to have Shift as a PlanningEntity, though - is there an updated version around, or are the docs just ahead of the implementation?
@ge0ffrey says
Good find! It's confusing.
It's a paradox.
What is a Shift?
A) a period of time during which one or more employees need to work
B) a period of time during which one employee needs to work, with other shifts happening in the same period of time
That docs section presumes A). The quickstart presumes B). Both are fine. For clarity, we need to rework that docs section to align with the quickstart. Please create an issue.
Contributor guide
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.
Assessment
This issue has not been assessed yet.