Evaluator API Commands Example doc

[c0d33ngr]

To close #4598

[lihaoyi]

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]

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]

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]

What do you think of the updated doc?

[lihaoyi]

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

[c0d33ngr]

I made some updates

1-depmapper example: It demonstrates a depMapper task command which uses the Evaluator API to resolve and execute tasks such as mvnDeps, test.mvnDeps, and allSourceFiles to generate a "Dependency Users Report" of source files

2-unreferencedfiles example: Here, an unreferencedFiles task command uses the Evaluator API to resolve, plan, and later evaluate to determine "known sources."

I can make more iterations if they're fit to be in the documentation