Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: fix misleading documentation in the design patterns document #357

Open
mwotton opened this issue Oct 23, 2023 · 1 comment
Open

Feat: fix misleading documentation in the design patterns document #357

mwotton opened this issue Oct 23, 2023 · 1 comment
Assignees
Labels
component/docs Improvements or additions to documentation enhancement New feature or request

Comments

@mwotton
Copy link

mwotton commented Oct 23, 2023

sourced from #266 (comment)

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 mwotton added enhancement New feature or request process/needs triage Requires initial assessment of validity, priority etc. labels Oct 23, 2023
@triceo triceo added component/docs Improvements or additions to documentation and removed process/needs triage Requires initial assessment of validity, priority etc. labels Oct 23, 2023
@triceo triceo self-assigned this Oct 23, 2023
@triceo
Copy link
Contributor

triceo commented Oct 23, 2023

Thanks for reporting, @mwotton!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/docs Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants