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

Simplifies the return type for parse_env_cfg method #965

Merged
merged 42 commits into from
Sep 10, 2024

Conversation

Mayankm96
Copy link
Contributor

@Mayankm96 Mayankm96 commented Sep 9, 2024

Description

Previously, the returned config object for parse_env_cfg mentioned the dictionary. However, this is hardly used or supported in our workflows code. This MR simplifies the return type to only be an instance of manager-based or direct environment configuration classes. Doing so, also cleans the code a bit by removing the need of explicit type-hinting.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have run the pre-commit checks with ./isaaclab.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 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

@Mayankm96 Mayankm96 added the enhancement New feature or request label Sep 9, 2024
@Mayankm96 Mayankm96 changed the base branch from main to fix/env-seed September 9, 2024 17:17
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Base automatically changed from fix/env-seed to main September 10, 2024 05:33
@Mayankm96 Mayankm96 self-assigned this Sep 10, 2024
@Mayankm96 Mayankm96 merged commit 5e84450 into main Sep 10, 2024
2 of 3 checks passed
@Mayankm96 Mayankm96 deleted the fix/simplify-parse-env-cfg branch September 10, 2024 07:19
iamdrfly pushed a commit to iamdrfly/IsaacLab that referenced this pull request Nov 21, 2024
# Description

Previously, the returned config object for `parse_env_cfg` mentioned the
dictionary. However, this is hardly used or supported in our workflows
code. This MR simplifies the return type to only be an instance of
manager-based or direct environment configuration classes. Doing so,
also cleans the code a bit by removing the need of explicit
type-hinting.

## Type of change

- Breaking change (fix or feature that would cause existing
functionality to not work as expected)

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.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 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

---------

Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant