azure-functions-templates icon indicating copy to clipboard operation
azure-functions-templates copied to clipboard

VS Code, Create new Project, C#, title and description can be made clearer

Open softchris opened this issue 4 years ago • 6 comments

Currently, you create a Durable functions project for C# in VS Code by following a wizard and selecting a task called DurableFunctionsOrchestration. What it in fact does it to give you a Start, Orchestration and first Activity function. That's great, but it's a surprise given its name and lack of a description (and given how it works for JavaScript where this is three separate tasks).

My suggestion:

Rename from DurableFunctionsOrchestration to DurableFunctionsStarter and add description saying something like this:

This task will create a Start function, and Orchestration function, and a first activity function. 

softchris avatar Jul 20 '20 17:07 softchris

@AnatoliB thoughts on this? This seems to make sense.

fabiocav avatar Jan 12 '22 21:01 fabiocav

I agree the current name is confusing. I'm not sure about the proposed name though, as "Starter" may be also interpreted as "the starter function only". @anthonychu, what do you think?

AnatoliB avatar Jan 12 '22 21:01 AnatoliB

Agree that it could use a better name but also agree that "starter" would be confusing in this context.

anthonychu avatar Jan 17 '22 23:01 anthonychu

@AnatoliB @anthonychu any thoughts on next steps to address this, we don't think it's part of the host project but should be tracked somewhere?

liliankasem avatar Jan 26 '22 21:01 liliankasem

@softchris Please note that the template is called DurableFunctionsOrchestration, and not DurableFunctionsOrchestrator. There is a difference between orchestrator and orchestration, even though these terms look similar:

  • Orchestrator is a function type. One of the functions created by the template will be of this type.
  • Orchestration is a more complex entity. I couldn't find a strict definition now, but please check out the link. This term is used to encompass all the involved orchestrator and function definitions (both orchestrator and activity functions), together with the execution context, history, etc. It is definitely not limited by the orchestrator function only.

With this idea in mind, the current name (DurableFunctionsOrchestration) does not look that bad. However, I do acknowledge the visual similarity of these two words, and I know that users often treat them as interchangeable. I'm still not convinced this deserves a change.

@cgillum What do you think about improving the template name?

AnatoliB avatar Jan 27 '22 21:01 AnatoliB

I think I mostly agree with what everyone has said so far. However, I do like the suggestion of "DurableFunctionsStarter". I agree it's ambiguous with the "client" function that's often used to "start" durable orchestrations, but I actually feel it's less ambiguous since there is no "starter" concept today (just the "client") and I assume most users won't have a preconceived notion of what a starter/client function is.

cgillum avatar Jan 27 '22 22:01 cgillum