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

Review and improve XML comments #387

Open
OlegRa opened this issue Oct 11, 2021 · 5 comments
Open

Review and improve XML comments #387

OlegRa opened this issue Oct 11, 2021 · 5 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@OlegRa
Copy link
Collaborator

OlegRa commented Oct 11, 2021

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!

@OlegRa OlegRa added enhancement New feature or request help wanted Extra attention is needed Hacktoberfest labels Oct 11, 2021
@OlegRa OlegRa added this to the SDK 6.0.x Experimental milestone Oct 11, 2021
@OlegRa OlegRa changed the title Review XML comments Review and improve XML comments Oct 11, 2021
@OlegRa OlegRa pinned this issue Oct 11, 2021
@mohitsaxenaknoldus
Copy link

mohitsaxenaknoldus commented Oct 12, 2021

I am starting to work on this. Are you talking about these files?: https://github.com/alpacahq/alpaca-trade-api-csharp/tree/develop/Documentation
@OlegRa

@mohitsaxenaknoldus
Copy link

Hey @OlegRa I need some help finding these comments. I can't seem to find any XML comments in the Documentation directory.

@OlegRa
Copy link
Collaborator Author

OlegRa commented Oct 14, 2021

@mohitsaxenaknoldus The Documentation directory contains the DocFX project that generates HTML files from the XML documentation files. The XML documentation in their turn generated from the C# source code (.cs files) by the C# compiler. So you have to review these .cs files, fix issues, build HTML files (use the Documentation solution configuration) and verify results.

@OlegRa OlegRa removed this from the SDK 6.0.x Experimental milestone Oct 18, 2021
@mohitsaxenaknoldus mohitsaxenaknoldus removed their assignment Oct 20, 2021
@OlegRa OlegRa added this to the SDK 6.0.x Experimental milestone Nov 29, 2021
@OlegRa OlegRa self-assigned this Mar 7, 2022
natehitze added a commit to natehitze/alpaca-trade-api-csharp that referenced this issue Apr 8, 2022
@natehitze natehitze mentioned this issue Apr 8, 2022
5 tasks
OlegRa pushed a commit that referenced this issue Apr 17, 2022
* XML docs updates for #387
* Change Invoked to Occurs
* Formatting updates
@natehitze
Copy link
Contributor

@OlegRa Is there more you want for this issue?

@OlegRa
Copy link
Collaborator Author

OlegRa commented Apr 28, 2022

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants