Repository navigation
Docstrings and annotations - #320
Merged
Merged
Conversation
… usage instructions
- Added type hints for method parameters and return types across various configuration classes including FastsimConfiguration, FomConfiguration, IsolationCone, IsolationConfiguration, IsolationSumPt, MergingConfiguration, RecastConfiguration, and TauIdentification. - Improved docstrings to provide clearer descriptions of class attributes, methods, and their parameters. - Corrected minor issues in logging messages and error handling. - Ensured consistent formatting and style across all configuration files.
- Added type hints and detailed docstrings to the detection classes for pdflatex, python, root, root graphical, simplify, spey, zlib, and session/user info. - Improved method signatures to include return types and argument types for better clarity and type checking. - Updated logging messages for clarity and consistency. - Fixed minor issues in the detection logic and comments.
|
Hello. You may have forgotten to update the changelog!
|
- Updated type hints for function parameters and return types in `install_delphes.py`, `install_service.py`, `cutflow_for_dataset.py`, `layout.py`, `merging_plots.py`, `plotflow.py`, `plotflow_for_dataset.py`, `histfactory_reader.py`, `run_recast.py`, `test_run_recast.py`, and `theoretical_error_setup.py`. - Improved docstrings to provide clearer descriptions of functions, parameters, and return values, enhancing code readability and maintainability. - Added type checks for various data structures, including lists and dictionaries, to ensure better type safety.
- Added detailed Doxygen-style comments to header and implementation files for LHEWriter, SAFWriter, WriterBase, WriterManager, and WriterTextBase, improving code readability and maintainability. - Updated the newAnalyzer.py script to include type hints and docstrings for better clarity and usability. - Included smoke tests for various interfaces (Delphes, FastJet, HEPTopTagger, etc.) with appropriate documentation to ensure proper linking and functionality. - Improved error handling and comments in the newAnalyzer.py script to guide users in creating new analysis classes.
jackaraz
marked this pull request as ready for review
September 28, 2026 13:21
BFuks
approved these changes
Sep 28, 2026
BFuks
approved these changes
Sep 28, 2026
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
2 participants
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.
Improve documentation throughout MadAnalysis.