Make create_empty.py less verbose - easier for beginners
#309
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
To me, this seems like a matter of personal preference. For a new user who wants to go through the code and understand it, the comments may help or may come in the way depending on what you're used to. Thus, I don't think this is necessary for us. |
ADebor
pushed a commit
to ADebor/IsaacLab
that referenced
this pull request
Apr 8, 2024
…saac-sim#327) # Description This PR adds a script to run all the unit tests (any Python script named `test_*.py`) and report on the success rate and timing. It also enables the skipping of known breaking tests via tests_to_skip.py. The tests can be run via `orbit -t`, and the test output will be printed to both a log (`test_results.log`) and to the console. This can be used for CI/CD but also can be temporarily used to run each test without invoking them manually one by one until we have a better solution. A few tests are currently broken; for now, these are added to tests_to_skip - I will put follow-up issues + PRs to fix these as soon as possible. I recommend we add running tests as a requirement before merging PRs until the CI/CD project is complete, too. One way to help facilitate this is to have PR authors copy/paste the results at the end of the test run to the PR description. Fixes isaac-sim#309 ## Type of change - New feature (non-breaking change which adds functionality) ## Screenshots An example test result summary with timeout set to 60 seconds running on my workstation: ``` =================== Test Result Summary =================== Total: 39 Passing: 29 Failing: 0 Skipped: 8 Timing Out: 2 Passing Percentage: 94.87% Total Time Elapsed: 0.0h31.0m52.38s ``` ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./orbit.sh --format` - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] 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
fatimaanes
pushed a commit
to fatimaanes/omniperf
that referenced
this pull request
Aug 8, 2024
…saac-sim#327) # Description This PR adds a script to run all the unit tests (any Python script named `test_*.py`) and report on the success rate and timing. It also enables the skipping of known breaking tests via tests_to_skip.py. The tests can be run via `orbit -t`, and the test output will be printed to both a log (`test_results.log`) and to the console. This can be used for CI/CD but also can be temporarily used to run each test without invoking them manually one by one until we have a better solution. A few tests are currently broken; for now, these are added to tests_to_skip - I will put follow-up issues + PRs to fix these as soon as possible. I recommend we add running tests as a requirement before merging PRs until the CI/CD project is complete, too. One way to help facilitate this is to have PR authors copy/paste the results at the end of the test run to the PR description. Fixes isaac-sim#309 ## Type of change - New feature (non-breaking change which adds functionality) ## Screenshots An example test result summary with timeout set to 60 seconds running on my workstation: ``` =================== Test Result Summary =================== Total: 39 Passing: 29 Failing: 0 Skipped: 8 Timing Out: 2 Passing Percentage: 94.87% Total Time Elapsed: 0.0h31.0m52.38s ``` ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./orbit.sh --format` - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
For me personally (as a beginner), the current file is too verbose - all the comments stand in the way of clearly seeing only the operations which need to happen.
Plus, some comments just repeat the function names (like main) which doesn't really add info. Code here can be self-documenting.
The proposed result (without red/green diffs): here.
TODO (after the code has been approved):
Type of change
Checklist
pre-commitchecks with./orbit.sh --format./orbit.sh --testand they passconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there