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

[BE] - Update docstrings and formatting for sims.habitat_simulator.object_state_machine.py #2017

Conversation

aclegg3
Copy link
Contributor

@aclegg3 aclegg3 commented Aug 19, 2024

Motivation and Context

Added module docstring and remaining param docstrings.

How Has This Been Tested

CI and Daniel will test building the docs.

Types of changes

  • [Docs change] Addition or changes to the documentation

Checklist

  • My code follows the code style of this project.
  • I have updated the documentation if required.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes if required.

@aclegg3 aclegg3 requested a review from danieltmeta August 19, 2024 22:30
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Aug 19, 2024
Copy link
Contributor

@danieltmeta danieltmeta left a comment

Choose a reason for hiding this comment

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

Please update the docstring comment for dt

Copy link
Contributor

@danieltmeta danieltmeta left a comment

Choose a reason for hiding this comment

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

Docstring annotations approved!

…docstring_sims_habitatsimulator_object_state_machine
@aclegg3 aclegg3 merged commit 928e16a into main Aug 21, 2024
4 checks passed
@aclegg3 aclegg3 deleted the daniel-07_18-cleanup_docstring_sims_habitatsimulator_object_state_machine branch August 21, 2024 23:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants