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 describe policies fix typos #42

Closed
wants to merge 4 commits into from

Conversation

jwong-nd
Copy link
Collaborator

@jwong-nd jwong-nd commented Jun 14, 2024

  • More Policy documentation, updated in Readme and rst files.
  • Conceal base classes/extra refs in rst documentation for cleaner user experience.
  • Typo, Typo in Trainer description #27

@jwong-nd jwong-nd requested review from bruno-f-cruz and dyf June 14, 2024 18:29

A good example of using PolicyGraphs can be demonstrated in the 'Track' curriculum above.

Imagine 'Track Stage' manages two rig parameters, P1 and P2,and these rig parameters update independently from one another
Copy link
Collaborator

Choose a reason for hiding this comment

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

I dont think we should use "rig parameters" in the language of the repo as this might be confusing against the way sci comp is using a rig.json schema

Copy link
Collaborator

Choose a reason for hiding this comment

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

Any reason to go back to this way of documenting the classes?

@bruno-f-cruz
Copy link
Collaborator

I merged this to #66 via #72

@jwong-nd jwong-nd closed this Jan 7, 2025
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.

2 participants