Skip to content

[docs] Add missing package docs #5108

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
Merged
merged 4 commits into from
Mar 15, 2021
Merged

[docs] Add missing package docs #5108

merged 4 commits into from
Mar 15, 2021

Conversation

ervteng
Copy link
Contributor

@ervteng ervteng commented Mar 12, 2021

Proposed change(s)

Added docs that failed the XmlDoc check on the package.

Types of change(s)

  • Bug fix
  • New feature
  • Code refactor
  • Breaking change
  • Documentation update
  • Other (please describe)

Checklist

  • Added tests that prove my fix is effective or that my feature works
  • Updated the changelog (if applicable)
  • Updated the documentation (if applicable)
  • Updated the migration guide (if applicable)

Other comments

vincentpierre
vincentpierre approved these changes Mar 12, 2021
View reviewed changes
com.unity.ml-agents/Runtime/SimpleMultiAgentGroup.cs Outdated


/// <summary>
/// Unregister all member Agents on dispose of SimpleMultiAgentGroup.
Copy link
Contributor

Choose a reason for hiding this comment

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

This describes what the code does. I think it should just be Disposes of the SimpleMultiAgentGroup.

dongruoping
dongruoping reviewed Mar 12, 2021
View reviewed changes
com.unity.ml-agents/Runtime/IMultiAgentGroup.cs Outdated
/// <summary>
/// Register agent to the MultiAgentGroup.
/// </summary>
/// <param name="agent">The Agent to unregister.</param>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// <param name="agent">The Agent to unregister.</param>
/// <param name="agent">The Agent to register.</param>

dongruoping
dongruoping approved these changes Mar 12, 2021
View reviewed changes
Copy link
Contributor

@dongruoping dongruoping left a comment

Choose a reason for hiding this comment

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

👍 for the MultiAgentGroup part :)

@ervteng ervteng merged commit 1c9b3ff into release_15_branch Mar 15, 2021
@delete-merged-branch delete-merged-branch bot deleted the release_15_fix_package_docs branch March 15, 2021 15:28
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
2 more reviewers

@dongruoping dongruoping dongruoping approved these changes

@vincentpierre vincentpierre vincentpierre approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ervteng @dongruoping @vincentpierre