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

Fixes various typos in the documentation #321

Merged
merged 4 commits into from
Mar 24, 2024

Conversation

VladimirFokow
Copy link
Contributor

@VladimirFokow VladimirFokow commented Mar 22, 2024

Description

  • fix typo: "For completion" with "For completeness"
  • fix typo: reset
  • fix typo: blocks
  • add my name to CONTRIBUTORS.md
  • fix typo: remove "is"

Fixes #302, #303, #304

This PR is a squash of these previous pull requests:
#310, #311, #312, #315

Type of change

  • This change requires a documentation update

Checklist

  • I have run the pre-commit checks with ./orbit.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have run all the tests with ./orbit.sh --test and they pass
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

- fix typo: "For completion" with "For completeness"

- fix typo: reset

- fix typo: blocks

- fix `--checkpoint` docs

- better phrasing about --checkpoint

- add my name to CONTRIBUTORS.md

- fix typo: remove "is"
@Mayankm96 Mayankm96 changed the title fix several things in the docs Fixes various typos in the documentation Mar 22, 2024
@Mayankm96 Mayankm96 added the documentation Improvements or additions to documentation label Mar 22, 2024
Copy link
Contributor

@Mayankm96 Mayankm96 left a comment

Choose a reason for hiding this comment

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

The checkpoint loading still seems not the clearest to me after your changes.

@VladimirFokow
Copy link
Contributor Author

VladimirFokow commented Mar 22, 2024

Sorry if something is wrong - my knowledge stops at this point.
Unfortunately, I don't have the ability to figure this out in the near future.

@Mayankm96
Copy link
Contributor

No worries. If you remove the checkpoint loading changes, we can look into clarifying that part from our side. Thanks!

@Mayankm96 Mayankm96 merged commit a30d764 into isaac-sim:main Mar 24, 2024
@VladimirFokow VladimirFokow deleted the fix-some-docs branch April 17, 2024 20:34
fatimaanes pushed a commit to fatimaanes/omniperf that referenced this pull request Aug 8, 2024
## Description

This MR improves the documentation:

- fix typo: "For completion" with "For completeness" 
- fix typo: reset 
- fix typo: blocks 
- fix typo: remove "is"

Fixes isaac-sim#302, isaac-sim#303, isaac-sim#304

## Type of change

- This change requires a documentation update

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./orbit.sh --format`
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have run all the tests with `./orbit.sh --test` and they pass
- [ ] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] replace phrase: "for completion" -> "for completeness"
2 participants