• Mayank Mittal's avatar
    Fixes docs building for the `orbit.envs` submodule (#438) · 8f1ba9aa
    Mayank Mittal authored
    # Description
    
    With recent upgrade to Python 3.10, the linter was forcing changing of
    types to use the new syntax that uses "|" operator.
    
    This means that the line in `base_env.py` was getting converted to this
    type as well:
    
    ```python
    # old
    VecEnvObs = Dict[str, torch.Tensor | Dict[str, torch.Tensor]]
    
    # new
    VecEnvObs = dict[str, torch.Tensor | dict[str, torch.Tensor]]
    ```
    
    Unfortunately, Pytorch does not support this type of alias yet. This
    leads to errors when building the documentation. The MR reverts to the
    old setting and disables `pyupgrade` linter check for that file
    (currently not possible to disable the linter for a line itself).
    
    Fixes #432
    
    ## Type of change
    
    - Bug fix (non-breaking change which fixes an issue)
    
    ## 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
    - [ ] I have added tests that prove my fix is effective or that my
    feature works
    - [x] I have run all the tests with `./orbit.sh --test` and they pass
    - [x] 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
    8f1ba9aa
Name
Last commit
Last update
..
developer.rst Loading commit data...
installation.rst Loading commit data...
sample.rst Loading commit data...