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

docs: use documentation tags where appropriate #130

Merged
merged 9 commits into from
Aug 31, 2022

Conversation

malandis
Copy link
Contributor

@malandis malandis commented Aug 30, 2022

Use the breadth of .NET documentation tags where appropriate. The previous code had markdown in places which will not display correctly in Intellisense.

This also reduces a lot of copy-paste documentation by using inheritdoc.

Closes #127

Copy link
Contributor

@bruuuuuuuce bruuuuuuuce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit: love it!

@malandis malandis marked this pull request as ready for review August 30, 2022 20:40
Copy link
Member

@eaddingtonwhite eaddingtonwhite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow interesting did not know you could do this w/ c#. TIL c# suprises me in new ways every day. :) This looks cleaner/easier to maintain to me! Nice work! we should make sure to double check in IDE as well make sure all looks good to end user w/ this new approach.

@malandis
Copy link
Contributor Author

I verified in VS Code but we should followup in Visual Studio and Rider as well.

@malandis malandis merged commit ee32af3 into main Aug 31, 2022
@malandis malandis deleted the docs/use-documentation-tags branch August 31, 2022 00:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

use C# documentation tags
3 participants