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

Flesh out Evaluator example docs (500USD Bounty) #4598

Open
lihaoyi opened this issue Feb 20, 2025 · 0 comments
Open

Flesh out Evaluator example docs (500USD Bounty) #4598

lihaoyi opened this issue Feb 20, 2025 · 0 comments
Labels

Comments

@lihaoyi
Copy link
Member

lihaoyi commented Feb 20, 2025


From the maintainer Li Haoyi: I'm putting a 500USD bounty on this issue, payable by bank transfer on a merged PR implementing this.

See https://github.com/orgs/com-lihaoyi/discussions/6 for other bounties and the terms and conditions that bounties operate under


We previously only had one tiny hard-to-find section on the docs briefly mentioning Evaluator Commands https://mill-build.org/mill/fundamentals/bundled-libraries.html#_evaluator_experimental. Now that #4094 has landed, we should flesh it out with example use cases of resolveSegments, resolveTasks, plan, execute, and evaluate. These should be sufficiently realistic and sufficiently documented that someone reading the examples can figure out how to use Evaluator Commands in their own projects to do useful things.

This exercise might also flesh out some missing pieces or idiosyncrasies of the Evaluator API, allowing us to fix them before the API is frozen by backwards compatibility requirements in 0.13.0

These example docs should be promoted to a standalone page in the documentation under website/docs/modules/ROOT/pages/extending/

@lihaoyi lihaoyi added the bounty label Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant