Skip to content

Commit b78cc99

Browse files
authored
Render source parameter descriptions visible
Make source parameter descriptions visible in online documentation.
1 parent f2c55e4 commit b78cc99

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

sourcefinder/utility/sourceparams.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,10 @@ def describe(self) -> str:
211211
# Ensure that all source parameters have a description
212212
assert all(p.value in _source_params_descriptions for p in SourceParams)
213213

214+
# This should render source parameter descriptions in Sphinx/RTD.
215+
for member in SourceParams:
216+
member.__doc__ = _source_params_descriptions.get(member.value, "")
217+
214218
# Set default set of source parameters to store in a file, e.g. a .csv file.
215219
_file_fields = [
216220
"PEAK",

0 commit comments

Comments
 (0)