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

Docstring correction for the __init__ instance of the PointLikeSourceI3DetSigYield class in /skyllh/i3/detsigyield.py #213

Closed
juanma-cano-vila opened this issue Feb 12, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@juanma-cano-vila
Copy link
Collaborator

This docstring is probably outdated. It mentions a implmethod that is not called anymore, and it does not include the description of the livetime instance.

def __init__(
self,
param_names,
dataset,
fluxmodel,
livetime,
sin_dec_binning,
**kwargs):
"""Constructor of the IceCube specific detector signal yield base
class for point-like sources.
Parameters
----------
param_names : sequence of str
The sequence of parameter names this detector signal yield depends
on. These are either fixed or floating parameters.
implmethod : instance of DetSigYieldImplMethod
The implementation method to use for constructing and receiving
the detector signal yield. The appropriate method depends on
the used flux model.
dataset : Dataset instance
The Dataset instance holding the monte-carlo event data.
fluxmodel : FluxModel
The flux model instance. Must be an instance of FluxModel.
sin_dec_binning : BinningDefinition instance
The BinningDefinition instance defining the sin(dec) binning.
"""

@juanma-cano-vila juanma-cano-vila self-assigned this Feb 12, 2024
@juanma-cano-vila juanma-cano-vila added the documentation Improvements or additions to documentation label Feb 12, 2024
juanma-cano-vila added a commit that referenced this issue Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant