Skip to content

Add tips in docs#5566

Closed
0xDevansh wants to merge 4 commits into
Unity-Technologies:mainfrom
0xDevansh:main
Closed

Add tips in docs#5566
0xDevansh wants to merge 4 commits into
Unity-Technologies:mainfrom
0xDevansh:main

Conversation

@0xDevansh

@0xDevansh 0xDevansh commented Oct 5, 2021

Copy link
Copy Markdown

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
Copy Markdown

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
Copy Markdown
Contributor

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

@jrupert-unity jrupert-unity left a comment

Copy link
Copy Markdown
Contributor

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.

@0xDevansh

Copy link
Copy Markdown
Author

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

@jrupert-unity

jrupert-unity commented Jan 19, 2022

Copy link
Copy Markdown
Contributor

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.

@0xDevansh

0xDevansh commented Jan 20, 2022

Copy link
Copy Markdown
Author

Alright, I'll do that

Edit: done

@montplaisir montplaisir mentioned this pull request Jun 10, 2026
10 tasks
@montplaisir

Copy link
Copy Markdown

Thanks for improving our docs! Your PR will be integrated as part of #6298.

Note that the documentation in the docs directory is no longer maintained. The updates will be done in directory com.unity.ml-agents/Documentation~/.

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.

6 participants