elsa-workflows / elsa-workflows/elsa-core

Add xmldocs

Open
#1,602 5 comments 0 reactions 0 assignees View on GitHub
documentation enhancement triaged
Dominant language
C#
Stars
7.9k
Forks
1.5k
Avg merge
15h 22m
Merged PRs (30d)
114

Description

Hi and thanks for this project!

It would be nice to add xmldocs on public APIs.

For example I just made a mistake and used `AddElsaCore` instead of `AddElsa`.
They both have the exact same signature, so it compiles. And their names are very similar so it's very easy to make this mistake.

At first I got an error saying IJavaScriptService could not be resolved, so I just added `services.AddJavaScriptExpressionEvaluator();`.

But then obviously nothing was running because AddElsaCore doesn't register the IHostedService.

So I wasted quite a bit of time on this. Some xmldocs could have maybe explained the difference between AddElsaCore and AddElsa.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.