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.

Sign up for GitHub

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

Jump to bottom

Inline documentation updates #9

Merged
merged 8 commits into from
Nov 24, 2023
Merged

Inline documentation updates #9

merged 8 commits into from
Nov 24, 2023

Conversation

kesac
Copy link
Owner

@kesac kesac commented Nov 24, 2023

What is changing?

  • Ensured that all classes, methods, and properties have XML documentation
  • When using Syllabore in another project, hovering over a Syllabore class, method, or property inside an IDE is guaranteed to display a summary tooltip

Why does the change need to happen?

  • It addresses a bug
  • It makes the library easier or more appealing to use
  • It makes the library easier to maintain
  • It future-proofs the library

@kesac kesac merged commit 70149ce into main Nov 24, 2023
@kesac kesac deleted the dev-documentation-updates branch November 24, 2023 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@kesac