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

Add xml-doc documentation for public API #356

Open
NameOfTheDragon opened this issue Mar 17, 2018 · 1 comment
Open

Add xml-doc documentation for public API #356

NameOfTheDragon opened this issue Mar 17, 2018 · 1 comment

Comments

@NameOfTheDragon
Copy link
Contributor

I know documentation is a dirty word in the open source community, but the Should* extension methods could really benefit from some IntelliSense support in Visual Studio. I know I'm always at a loss whether to use ShouldEqual, ShouldBeLike or ShouldBeTheSameAs because the differences are not immediately obvious from the names. Breaking out of the zone to read the source code of a support library isn't really an optimal way to get documentation.

I would be happy to have a go at adding some XML doc comments if that is any help.

@robertcoltheart
Copy link
Member

I'm working on bringing this project to life again, will look into adding some xml docs.

@robertcoltheart robertcoltheart transferred this issue from machine/machine.specifications.should Jan 8, 2019
@robertcoltheart robertcoltheart added this to the 2.0.0 milestone Jun 12, 2019
@robertcoltheart robertcoltheart changed the title Intellisense Add xml-doc documentation for public API Jun 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants