Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Add XML docs to enhance discoverability in IDEs #4
Just started working on it.
I assumed that Result can become Success or Failure and that way I'd like to continue commenting the code. If you have any thoughts on this, please share.
The english might not be perfect, so if something doesn't sounds good and should be rewritten, point it out as well.
As for the ways to call the paths, I'm thinking of using the track naming, like "Result is on success track" or "Result is on error track" to indicate the path. Thoughts?
And don't worry about the language at this point, we can do final review once all is done and improve it if there will be such need :)
I've recently created
If you won't be sure what to put in the docs for some type or method you can leave it to me or put TODO in comments and we can work on it together when the PR will be created.