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.

Sign up for GitHub

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

Jump to bottom

Docs: do not show argument types in function signature #71

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Docs: do not show argument types in function signature #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb68264
Docs: do not show argument types in function signature
gipert Nov 7, 2024
512bff0
Update lar.py parameter docs
ManuelHu Nov 8, 2024
1cb8e7a
Update tetratex.py parameter docs
ManuelHu Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
# sphinx-autodoc
# Include __init__() docstring in class docstring
autoclass_content = "both"
autodoc_typehints = "both"
autodoc_typehints = "description"
autodoc_typehints_description_target = "documented_params"
autodoc_typehints_format = "short"
# mock pyg4ometry that will sometimes lead to build failures.
Expand Down
2 changes: 1 addition & 1 deletion src/legendoptics/lar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ def pyg4_lar_attach_scintillation(

Parameters
----------
flat_top_yield_per_mev
flat_top_yield
Change the flat-top light yield of the scintillation response. Note that for
different particle types, the value might be lower (see :func:`lar_scintillation_params`).
triplet_lifetime_method
Expand Down
2 changes: 1 addition & 1 deletion src/legendoptics/tetratex.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def pyg4_tetratex_attach_reflectivity(mat, reg, reflectivity_scale: float = 1) -

Parameters
----------
tetratex_refl_scale
reflectivity_scale
Global scale for tetratex reflectivity.

See Also
Expand Down
Loading