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

Feature/78 ruff docstring formatting #109

Merged
merged 1 commit into from
Dec 28, 2023

Conversation

Mark2000
Copy link
Contributor

@Mark2000 Mark2000 commented Dec 27, 2023

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?

  • By commit
  • All changes at once

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

Tests still pass.

  • Unit tests (General Environment only) pytest --cov bsk_rl/envs/general_satellite_tasking --cov-report term-missing tests/unittest
  • Integrated tests (General Environment only) pytest --cov bsk_rl/envs/general_satellite_tasking --cov-report term-missing tests/integration

Test Configuration

  • Python: 3.10.11
  • Basilisk: 2.2.2
  • Platform: MacOS

Checklist:

  • My code follows the style guidelines of this project (passes Black, ruff, and isort)
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • Commit messages are atomic, are in the form Issue #XXX: Message and have a useful message
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@Mark2000 Mark2000 force-pushed the feature/78-ruff-docstring-formatting branch 3 times, most recently from 0668d07 to e01c6c0 Compare December 28, 2023 08:14
@Mark2000 Mark2000 marked this pull request as ready for review December 28, 2023 14:46
@Mark2000 Mark2000 force-pushed the feature/78-ruff-docstring-formatting branch from e01c6c0 to f8d5f7b Compare December 28, 2023 14:46
@Mark2000 Mark2000 requested a review from LorenzzoQM December 28, 2023 16:13
@Mark2000
Copy link
Contributor Author

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

@LorenzzoQM
Copy link
Contributor

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

Copy link
Contributor

@LorenzzoQM LorenzzoQM left a comment

Choose a reason for hiding this comment

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

Excellent changes to the repo!

@Mark2000
Copy link
Contributor Author

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

@Mark2000 Mark2000 merged commit 9a5b005 into develop Dec 28, 2023
4 checks passed
@Mark2000 Mark2000 deleted the feature/78-ruff-docstring-formatting branch December 28, 2023 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convert docstrings to Sphinx style
2 participants