Skip to content

Evaluator API Commands Example doc #5204

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

c0d33ngr
Copy link
Contributor

@c0d33ngr c0d33ngr commented May 27, 2025

To close #4598

@c0d33ngr c0d33ngr marked this pull request as ready for review May 29, 2025 11:22
@lihaoyi
Copy link
Member

lihaoyi commented May 30, 2025

This isn't really a good example showing off the Evaluator API. There is too much code unrelated to Evaluator and it doesn't explain or highlight what is interesting about the APIs that Evaluator exposes to users

@c0d33ngr
Copy link
Contributor Author

This isn't really a good example showing off the Evaluator API. There is too much code unrelated to Evaluator and it doesn't explain or highlight what is interesting about the APIs that Evaluator exposes to users

Thank you for the feedback.

Is it this style of writing the example doc for Evaluator API as is in mill built-in command here you was expecting?

How I understand the issue description was to use the mentioned Evaluator commands to do something and then explain what each commands do in the sample project.

@lihaoyi
Copy link
Member

lihaoyi commented May 30, 2025

The basic requirement is to clearly explain what the different APIs on the Evaluator object are useful for and how to use them. How you do so doesn't really matter, but the current PR does not successfully achieve that goal

@c0d33ngr c0d33ngr force-pushed the evaluator-example-doc branch from 71f539b to 685a361 Compare June 2, 2025 11:11
@c0d33ngr
Copy link
Contributor Author

c0d33ngr commented Jun 2, 2025

What do you think of the updated doc?

@lihaoyi
Copy link
Member

lihaoyi commented Jun 9, 2025

Looking through the examples, they are not sufficiently motivated to serve as useful explanations or examples to users. I think. And the evaluator.adoc is just a rehash of Scaladoc and type signatures and is similarly unhelpful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flesh out Evaluator example docs (500USD Bounty)
2 participants