Misc doc fixes #4483
Merged
Misc doc fixes #4483
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
September 14, 2020 11:46
chriselion
commented
Sep 14, 2020
| - exclude: | ||
| uidRegex: ^Unity.MLAgents\.Tests\.Communicator$ | ||
| type: Namespace | ||
| - exclude: |
Contributor
Author
There was a problem hiding this comment.
These were showing up in the API docs
chriselion
commented
Sep 14, 2020
| } | ||
|
|
||
| /// <inheritdoc cref="IEnumerable{T}.GetEnumerator"/> | ||
| /// <inheritdoc/> |
Contributor
Author
There was a problem hiding this comment.
Got some warnings from the verbose doc generation about these.
chriselion
commented
Sep 14, 2020
| /// Returns a read-only view of the observations that were generated in | ||
| /// <see cref="CollectObservations(VectorSensor)"/>. This is mainly useful inside of a | ||
| /// <see cref="Heuristic(float[], int[])"/> method to avoid recomputing the observations. | ||
| /// <see cref="Heuristic(in ActionBuffers)"/> method to avoid recomputing the observations. |
vincentpierre
approved these changes
Sep 15, 2020
Co-authored-by: Vincent-Pierre BERGES <vincentpierre@unity3d.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change(s)
Misc doc fixes
Types of change(s)
Checklist