Merged
Conversation
Added NumPy-style docstrings to 100+ functions across 23 files that had none. Key areas covered: - core/logger.py: all public logging helpers (info, warn, error, critical, debug, verbose, setVerbose, setDebug, deprecated, renameKwarg, warnNonEmptyArgs, whereAmI, _msg, _get_class_from_frame) - core/datacontainer.py: DataContainer monkey-patched methods - math/matrix.py: ScaledMatrix, TransposedMatrix, Squared*Matrix, MultMatrix family, RealNumpyMatrix, NDMatrix __init__ methods and property accessors - frameworks/inversion.py: ClassicInversion, MarquardtInversion, Block1DInversion, LBFGSInversion, LCInversion __init__ methods - frameworks/modelling.py: MeshModelling.__init__ - physics/ert/ertScheme.py: DataSchemeBase and all seven concrete scheme subclasses (PolePole, DipoleDipole, PoleDipole, HalfWenner, WennerAlpha, WennerBeta, Schlumberger, MultipleGradient) - physics/ert/ertModelling.py: ERTModelling, ERTModellingReference - physics/SIP/siptools.py: DebyeModelling, DoubleColeColeModelling - physics/SIP/models.py: ColeColeAbs - physics/gravimetry/MagneticsModelling.py: RemanentMagneticsModelling - physics/traveltime/modelling.py: TravelTimeDijkstraModelling and both FatrayDijkstra variants - physics/em/tdem.py: TDEMSmoothModelling - physics/sNMR/mrsprofile.py: MultiFOP - utils/sparseMat2Numpy.py: toCSR, toCOO aliases - utils/gps.py: _getXMLData - viewer/mpl/meshview.py, overlayimage.py: singleton cache methods - viewer/pv/pyqt/gwidgets/utils.py: GToolBar, GButton, GLineEdit, GComboBox, GSlider, GDoubleSpinBox, _GDoubleSlider methods - viewer/pv/pyqt/show3d.py: showHotKeys, setupWidget, _enableSlicers, _allowSignals, _checkStatusPlaneSlice, _checkStatusVolumeSlice Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi @carsten-forty2,
@halbmy and me asked Claude to document functions without a docstring and document missing keywords in existing docstrings + remove some Sphinx warnings. It looks quite good at first sight. Can you also check, please? You know some functions much better.
Thanks and best wishes
Florian