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

XML comment for Fin doesn't load properly #1406

Open
guythetechie opened this issue Nov 7, 2024 · 0 comments
Open

XML comment for Fin doesn't load properly #1406

guythetechie opened this issue Nov 7, 2024 · 0 comments

Comments

@guythetechie
Copy link

The XML summary comment for the Fin class doesn't load properly.
image

I think it's because of the unescaped < and > here:

/// Equivalent of `Either<Error, A>`

If I change it to the code below, it seems to work properly.

/// <summary>
/// Equivalent of `Either&lt;Error, A&gt;`
/// Called `Fin` because it is expected to be used as the concrete result of a computation
/// </summary>
public class FinTest
...

image

Who cares?

It might seem like a minor issue, but I plan on using Fin, Either, et. al. as Trojan horses for functional programming in codebases where maintainers aren't familiar with LanguageExt. Either<Error, int> is a very descriptive return type. Fin<int> is extremely convenient, but its meaning is less clear without mousing over the type for its description.

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

No branches or pull requests

1 participant