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

Document, typehint, and rearrange recon classes #1685

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

WYVERN2742
Copy link

@WYVERN2742 WYVERN2742 commented Feb 8, 2024

This is part of the software sustainability hackathon, and is part of a larger
project to improve cil's documentation. #1683

Describe your changes

Since the changes are quite large, this PR is limited to the cil.recon folder.

No functional code changes were performed.

  • Sorted imports
  • Document and typehint functions, following the numpy standard
    • Private functions are not documented.
  • Move __init__ to top of class
  • Move private functions to bottom of class
  • Standardise using " for strings
  • Explicitly state classes as abstract classes

Describe any testing you have performed

Please add any demo scripts to CIL-Demos/misc/

Link relevant issues

Checklist when you are ready to request a review

  • I have performed a self-review of my code
  • I have added docstrings in line with the guidance in the developer guide
  • I have implemented unit tests that cover any new or modified functionality
  • CHANGELOG.md has been updated with any functionality change
  • Request review from all relevant developers
  • Change pull request label to 'Waiting for review'

Contribution Notes

Please read and adhere to the developer guide and local patterns and conventions.

  • The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in CIL (the Work) under the terms and conditions of the Apache-2.0 License.
  • I confirm that the contribution does not violate any intellectual property rights of third parties

No functional code changes were performed.

- Sorted imports
- Document and typehint functions
	- Private functions are not documented.
- Move `__init__` to top of class
- Move private functions to bottom of class
- Standardise using `"` for strings
- Explicitly state classes as abstract classes
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.

1 participant