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: XML Comments improvements #2589

Merged
merged 2 commits into from
Feb 3, 2025

Conversation

VaclavElias
Copy link
Contributor

PR Details

Summaries added based on Bepu source code.

Related Issue

N/a.

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My change requires a change to the documentation.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have built and run the editor to try this change out.

@VaclavElias VaclavElias added the area-Doc Issues related to documentation and XML comments label Dec 29, 2024
@VaclavElias VaclavElias requested a review from Eideren December 29, 2024 17:50
@Eideren
Copy link
Collaborator

Eideren commented Dec 29, 2024

Duplicate of #2567 for all but one case - mine doesn't lift them all sale, I tried to actually explain the utility of those in layman's terms so I would rather keep mine

The only case that doesn't fit is SpeculativeMargins which would need a shorter summary than this I feel.

@VaclavElias
Copy link
Contributor Author

Nice, I should have studied more existing PRs 🤦‍♂️. Never mind. We can close this and you can take anything you need from SpeculativeMargins. I think, it's definitelly better as you do it, reworded and in layman's terms. Thanks. Didn't want to step on your toes 🤣.

I might ping Norbo, if he would like a help generating Bepu APIs to easier access all the features Bepu can offer but mainly we can direct readers also to the original docs if someone would like to dig deeper. Thanks.

@Eideren Eideren self-assigned this Jan 21, 2025
@Eideren Eideren merged commit 3ad2dbb into stride3d:master Feb 3, 2025
2 checks passed
@Eideren
Copy link
Collaborator

Eideren commented Feb 3, 2025

Thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Doc Issues related to documentation and XML comments
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants