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

[Documentation] Adding to the configuration's docstrings and adding them on Pages. #1101

Merged
merged 5 commits into from
Jan 30, 2023

Conversation

vincentpierre
Copy link
Contributor

Motivation and Context

Work towards milestone 0
Adding to the documentation of the configurations.
Documented the most important configurations for the Navigation tasks.
Fixed documentation issues appearing in the dataset.py file's docstring.
Fixed a typo in a doctring.

How Has This Been Tested

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@vincentpierre vincentpierre self-assigned this Jan 27, 2023
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jan 27, 2023
@vincentpierre vincentpierre changed the title [Documentation] [Documentation] Adding to the configuration's docstrings and adding them on Pages. Jan 27, 2023
@vincentpierre vincentpierre merged commit 84fa782 into facebookresearch:main Jan 30, 2023
dannymcy pushed a commit to dannymcy/habitat-lab that referenced this pull request Jul 8, 2024
…hem on Pages. (facebookresearch#1101)

* documenting nav: moveforward, stop, tilt

* documenting measures

* adding the lab sensor documentation for the navigation tasks

* Adding Habitat, Env, task configs

* fixing docstring compile issues

---------

Co-authored-by: vincentpierre <vincentpierre@users.noreply.github.com>
HHYHRHY pushed a commit to SgtVincent/habitat-lab that referenced this pull request Aug 31, 2024
…hem on Pages. (facebookresearch#1101)

* documenting nav: moveforward, stop, tilt

* documenting measures

* adding the lab sensor documentation for the navigation tasks

* Adding Habitat, Env, task configs

* fixing docstring compile issues

---------

Co-authored-by: vincentpierre <vincentpierre@users.noreply.github.com>
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