Documentation from NuGet package

[TysonMN]

I expected PR #251 to bring documentation to the tooltips in Visual Studio when consuming Hedgehog via NuGet package. I locally created a NuGet package (thanks to PR #253) and added it to a project, but I still don't see the documentation. I was talking with @dharmaturtle, and he has the same behavior.

@cmeeren, do you see the documentation in tooltips from a locally created NuGet package?

[cmeeren]

How did you build the new package and add it to the project? If you did not bump the version, you must ensure that you remove the old cached Hedgehog version from your global NuGet cache, otherwise it's the existing cached version that gets restored.

(Clearing the cache for Hedgehog would be wise anyway both before and after testing, otherwise you may have your custom one getting restored everywhere else.)

[cmeeren]

If you did not bump the version, you must ensure that you remove the old cached Hedgehog version from your global NuGet cache, otherwise it's the existing cached version that gets restored.

Also, I think you must clean your project if you had already installed Hedgehog, otherwise it won't install/restore anything (since it is already restored).

(I am actually currently working on a build-tool library where I'm required to perform these steps every time I update the library and want to test it.)

[dharmaturtle]

Here's where you can add a new package source in VS (Tools > Options):

Docs don't appear for Range.exponentaial for me, though they do appear for the __ prefixed methods below it (e.g. __exponentialBoundedDecimal).

As you can see I bumped the version to 0.8.555. I also tested with 0.8.5. Note the package source in the upper right corner.

Interestingly enough, the docs for Hedgehog.Experimental work for me (both the official nuget version and my own custom built Hedgehog.Experimental.0.2.444.nupkg.

---

You may wish to clean up the %userprofile%\.nuget\packages\hedgehog and %userprofile%\.nuget\packages\hedgehog.experimental directories if you install a new version. I'm not sure what happens if later a "real" release comes out with a version number you were previously testing with.

[dharmaturtle]

Ah, this is due to the fact that we're prepending - to the CompiledName.

[TysonMN]

Excellent work @dharmaturtle!

@moodmosaic, what is the purpose for - in compiled names?

[dharmaturtle]

@TysonMN #219

[cmeeren]

@moodmosaic What's the purpose of all the __-prefixed stuff? If it is intended as implementation details, but has to be public due to being used in inline code, then it's much better to annotate it with [<EditorBrowsable(EditorBrowsableState.Never)>] (requires open System.ComponentModel).

[moodmosaic]

What's the purpose of all the __-prefixed stuff?

It turns out that those can't be used outside F#, so we try to 'hide' them from IntelliSense: #156 (comment)

to annotate it with [<EditorBrowsable(EditorBrowsableState.Never)>] (requires open System.ComponentModel).

I've tried that, of course, but then they were hidden also from inside F#'s IntelliSense: #156 (comment)

[moodmosaic]

@TysonMN, @dharmaturtle, @cmeeren, if they are causing some unexpected behavior, now it's time to do something for it, before cutting a release. Though, I (and I believe also @mausch) couldn't see anything unusual in Rider.

[dharmaturtle]

Changing the - to a backtick ( `) resolves this issue for Visual Studio:

Exponential is still hidden from C#:

And still works for Rider:

I can make a PR for this if yall like this solution.

[moodmosaic]

Awesome! Go for it, @dharmaturtle 🎸

[moodmosaic]

@cmeeren, are you fine waiting for a PR by @dharmaturtle? Might push v0.9.0 release to Wednesday or Thursday.

[cmeeren]

That's fine with me, I'm in no hurry.