How or where do I get documentation on a NuGet package?

Question

1.00/5 (1 vote)

See more:

I am struggling with the implementation of a spell checker for my project. I have determined that the spellnet Nuget package is the best way to go. Using Visual Studio vb.net. I have found one example, but I am wondering if there is some better documentation on the use of the package.

What I have tried:

I've tried various searches including chatGpt

Posted 24-Feb-24 7:54am

Eli Schneider 2024

Updated 24-Feb-24 9:24am

PIEBALDconsult

v2

Add a Solution

Comments

Pete O'Hanlon 24-Feb-24 17:03pm

Perhaps put a link to the nuget package that you have downloaded.

2 solutions

Solution 2

To add to what Dave has - rightly - said ...
It is indeed quite possible there is no documentation: if that is true, or the necessary documents aren't easy to find then the best course of action is to dump it and look again.

Quote:
I have determined that the spellnet Nuget package is the best way to go.

Part of the evaluation criteria for any package has to be "is there sufficient documentation so that I can actually use this?". If the answer to that is no, then you need to reevaluate your whole approach as you will waste huge amounts of time trying to get undocumented packages working by trial and error.

Think about why you settled on this particular package: we have no idea what your criteria were, but I think your whole approach was flawed if you can't even begin to use the package you selected without external help!

Posted 24-Feb-24 19:30pm

OriginalGriff

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Dave Kreskowiak · Accepted Answer · 2024-02-24T14:12:00

There is no repository for documentation of all Nuget packages. Hell, there's isn't even a requirement for anyone making a publicly available Nuget package to include documentation or supply a link to any.

It's entirely possible there isn't any documentation!

For any possible documentation, go to nuget.org and search for your package name. Click on your package and on the right there is usually a "Project website" link. Click that and you may find documentation.

I searched for "Spellnet" and found there is no Nuget package called that.