Documentation improvements for classes in Objective Function Pieces #1292
Conversation
Objective Function Pieces. Overal I tried to give better - descriptions for classes/methods/attributes - punctuation marks corrections.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1292 +/- ##
=======================================
Coverage 82.30% 82.30%
=======================================
Files 165 165
Lines 25241 25241
=======================================
Hits 20775 20775
Misses 4466 4466 ☔ View full report in Codecov by Sentry. |
|
I've just noticed that I missed some corrections, I need to work a bit more on it before this PR really gets ready. I plan to have it finished before the next weekly meeting. |
Making sure everything is numpy style.
|
I've finished what I think was necessary for this PR to be ready for a review. |
|
@ghwilliams please add summary and keep PR checklist up to date. Suggest: Summary: Add proper docstrings for data_misfit.py and objective_function.py (and simulation.py?) |
santisoler
left a comment
There was a problem hiding this comment.
Huge thanks @ghwilliams! Awesome job adding all these docstrings. Users will greatly appreciate it.
I've added a few minor suggestions, mostly corrections to LaTeX equations and some changes to follow numpydocs style.
Feel free to commit the suggestions, or make your own changes if you think they could be improved. Let me know what do you think.
I'm looking forward to merge this and see you in the contributors list! 🚀
|
Thanks @santisoler . I'll review everything and talk to @dccowan to see if we can consider it ready to be merged or if it still needs any corrections. |
|
Thanks @ghwilliams for applying all the suggestions. I think this is ready to be merged. I've just updated the branch with the latest changes in Thanks again for the contributions! They are greatly appreciated! |
|
Thanks @ghwilliams for all the effort of writing these docstrings! Your contributions are greatly appreciated! I'm merging this! 🚀 |
* main: Fix typo in error messages (simpeg#1324) Update test_regularization.py to test vector derivatives. Update AmplitudeSmoothnessFirstOrder in vector.py so that the call matches the derivative. Move `__init__` in `BaseSimulation` to the top of the class (simpeg#1323) Bump versions of flake8 and black and pin flake plugins (simpeg#1330) Update test_regularization.py to test vector derivatives. Update AmplitudeSmoothnessFirstOrder in vector.py so that the call matches the derivative. Update test_regularization.py to test vector derivatives. Update AmplitudeSmoothnessFirstOrder in vector.py so that the call matches the derivative. Add `weights_keys` method to `BaseRegularization` (simpeg#1320) Fix description of source_field in gravity survey (simpeg#1322) Documentation improvements for classes in Objective Function Pieces (simpeg#1292) # Conflicts: # tests/base/regularizations/test_regularization.py
@dccowan Please take a look at this tentative improvement of the documentation.
Summary
Add proper docstrings to classes and methods in
data_misfit.pyandobjective_function.py.PR Checklist
expect style.
to a Pull Request
@simpeg/simpeg-developerswhen ready for review.Reference issue
What does this implement/fix?
Additional information