-
-
Notifications
You must be signed in to change notification settings - Fork 81
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
Review and improve XML comments #387
Comments
I am starting to work on this. Are you talking about these files?: https://github.com/alpacahq/alpaca-trade-api-csharp/tree/develop/Documentation |
Hey @OlegRa I need some help finding these comments. I can't seem to find any XML comments in the |
@mohitsaxenaknoldus The |
@OlegRa Is there more you want for this issue? |
@natehitze First, thanks a lot for your work and your PR - it's really valuable and I hope it will make SDK usage in IDE simpler. Second, I have some ideas about improving auto-generated documentation in general but these changes are mostly related to DocFx styling/content not to XML documentation. If you have some experience in this area and willingness to help - I can open a separate issue for discussing possible improvements. |
The built-in C# XML documentation contains a lot of incorrect spelling, unclear wording, and other errors. Review XML documentation comments in code, fix typos, and improve clearness. I'm open to accepting pull requests with these fixes. Let's make SDK better for new users together!
The text was updated successfully, but these errors were encountered: