docusign
Need SDK documentation
Hey, the library is great, but we need documentation. The Nuget package does not install any xml documentation for the classes.
Is there documentation anywhere for this library?
@escallin , you are correct, we do not yet have documentation. I'm sorry for that, we'll try to get some documentation in the future. In the interim - do you have any questions that I can help you with? We do have some sample code that shows some examples of how to use the library and there are more than 30 unit tests as well that exercise the code, those can be useful as well. I do acknowledge the need for formal documentation, we haven't had a chance to assemble that yet. Let me know if I can assist in any way.
Hello Inbar. Thank you for the quick reply. I noticed that a lot of the source code IS xml commented. If you could include all the xml comments as a separate XML Documentation file so that intellisense would work, that would be a good start.
I am trying to accomplish a specific task that you don’t have an example for. Let me write up a scenario and I will send it to you. Should I ask it in the “issues” board here at github, or is there a better place?
Thanks, Eric
From: Inbar Gazit [mailto:[email protected]] Sent: Thursday, March 12, 2015 11:43 AM To: docusign/DocuSign-.NET-Client Cc: Eric Scallin Subject: Re: [DocuSign-.NET-Client] Need documentation (#13)
@escallinhttps://github.com/escallin , you are correct, we do not yet have documentation. I'm sorry for that, we'll try to get some documentation in the future. In the interim - do you have any questions that I can help you with? We do have some sample code that shows some examples of how to use the library and there are more than 30 unit tests as well that exercise the code, those can be useful as well. I do acknowledge the need for formal documentation, we haven't had a chance to assemble that yet. Let me know if I can assist in any way.
— Reply to this email directly or view it on GitHubhttps://github.com/docusign/DocuSign-.NET-Client/issues/13#issuecomment-78506084.
@escallin , I see, you can get the source here and then would have intelisense, but you want to use the nuget and it's not coming through, right? we would definitely get this fixed soon. I need to figure out how to do that and would get back to you.
As for the scenario - sure, feel free to open an issue here so it's publicly shared with others who might have the same need.
Thanks for your patience!
Yes, that’s correct. The nuget package only downloads the compiled dll.
I was able to compile the source code from github and output the XML Documentation file. Once the file is place with the dll from NuGet, the Intellisense will work. I think you should still include it in the NuGet package so that it updates.
I did notice that the source code is not as well documented as I thought. Most of the documentation is generic like "Get or Sets the xxxx property". Really need to now what the property or method is used for.
Thanks, Eric
Thanks Eric, I appreciate the feedback. We would do our best to improve documentation in the future. Please let me know if there's something I can help you with in the interim.
Has there been any progress on this? It would be very useful if NuGet installed IntelliSense xml files along with the library. It is quite a pain to have to have the documentation open in one window with Visual Studio in another. People with only one monitor I'm sure are wearing out their ALT and TAB keys.
I did some quick digging, and I think this is what you want.
EDIT: I will also second Eric's comment that even looking at the documentation, a lot of it is not adequately commented. Making a more developer-friendly library would go a long way toward encouraging adoption. Not to be rude, but if I were in charge of my project, I would probably be looking into HelloSign and some other options to see if their C# libraries were any better.
Hi Everybody, First, I do apologize for our (DocuSign's) very slow responses to issues raised in the repo. We've reorganized to improve matters.
We share your desire to document the SDK itself. Since each SDK method has a one-to-one correspondence to an API method, the API reference documentation can often be used.
