timefold-solver icon indicating copy to clipboard operation
timefold-solver copied to clipboard

Feat: fix misleading documentation in the design patterns document

Open mwotton opened this issue 2 years ago • 1 comments

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

267516355-8952fe2b-d7ef-4f32-9284-20180cc03049

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.

mwotton avatar Oct 23 '23 03:10 mwotton

Thanks for reporting, @mwotton!

triceo avatar Oct 23 '23 05:10 triceo