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

Add tips in docs #5566

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

DeathVenom54
Copy link

@DeathVenom54 DeathVenom54 commented Oct 5, 2021

Proposed change(s)

I updated a code block and added little tips to explain things better, ones I wish were included when I was first learning from the docs.

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

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@miguelalonsojr
Copy link
Collaborator

@maryamhonari or @jrupert-unity can you have a look at this PR? Seems reasonable since it's a doc update.

Copy link
Contributor

@jrupert-unity jrupert-unity left a comment

Choose a reason for hiding this comment

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

Changes make some good improvements, but need work.

I would remove the change around line 234.
I'd remove line 270 and change 272&273 to use actionBuffers.ContinuousActions[]. Same with 319&320.
Line 264 should say ContinuousActions[] or actionBuffers.ContinuousActions[].
Line 443 should be "Make sure the behavior name in the 'Behavior Parameters' component matches the one in the config file." to fix spelling and punctuation.

@DeathVenom54
Copy link
Author

Hey I am very new to OS contributions. I cannot see any options to edit the code in my pull request.

@jrupert-unity
Copy link
Contributor

jrupert-unity commented Jan 19, 2022

I think if you push more changes to the file the pull request will update. Alternatively if Miguel approves we can accept this pull request and I can update with my changes after that.

Add more commits by pushing to the main branch on DeathVenom54/ml-agents.

@DeathVenom54
Copy link
Author

DeathVenom54 commented Jan 20, 2022

Alright, I'll do that

Edit: done

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.

None yet

5 participants