AVSLab / bsk_rl

RL environments and tools for spacecraft autonomy research, built on Basilisk. Developed by the AVS Lab.
https://avslab.github.io/bsk_rl/
MIT License
36 stars 2 forks source link

Feature/78 ruff docstring formatting #109

Closed Mark2000 closed 6 months ago

Mark2000 commented 6 months ago

Description

Closes #78 Closes #94 - duplicates work in that PR

Adds ruff formatting rules for docstrings in envs/general_satellite_tasking. Will roll out to other parts of repo after refactoring of environments into general env. Note that a fairly new ruff>=0.1.9 is required for some features.

How should this pull request be reviewed?

Type of change

How Has This Been Tested?

Tests still pass.

Test Configuration

Checklist:

Mark2000 commented 6 months ago

Let me know if you think the scope should be bigger than just the general env

LorenzzoQM commented 6 months ago

I believe limiting the scope for the general environment for now is enough - it is what we are mainly using.

Mark2000 commented 6 months ago

Also working on configuration for #98 , should have some decent documentation generation soon.