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

Update AlphaOption.cs xml docs #1465

Merged
merged 2 commits into from
Oct 21, 2023
Merged

Update AlphaOption.cs xml docs #1465

merged 2 commits into from
Oct 21, 2023

Conversation

kmgallahan
Copy link
Contributor

@kmgallahan kmgallahan commented Oct 21, 2023

This copies over the descriptions from the official docs.

Description

I think adding the full descriptions here would be useful. Although it does present a potential source of maintenance if things change.

Good or bad to update the xml comments like this in some places?

  • Discrete has no documentation
  • On/Off don't either, although they are somewhat self-explanatory
  • Undefined has... undefined behavior
  • Associate/Disassociate docs are somewhat ambiguous compared to the others

This copies over the descriptions from the official docs.
Copy link
Owner

@dlemstra dlemstra left a comment

Choose a reason for hiding this comment

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

Thanks for improving the documentation and feel free to add more of these kind of changes.

@dlemstra dlemstra merged commit 546507e into dlemstra:main Oct 21, 2023
26 checks passed
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.

2 participants