Skip to content

Commit 9eddd8a

Browse files
committed
Use plain enums
Inheriting from str leads to noisy docs.
1 parent 9a716bf commit 9eddd8a

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/scippneutron/metadata/_model.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,25 +291,30 @@ def _deduce_package_source_url(package_name: str) -> str | None:
291291
return None
292292

293293

294-
class SourceType(str, enum.Enum):
294+
class SourceType(enum.Enum):
295295
"""Type of source.
296296
297297
Names are based on NeXus definitions.
298298
"""
299299

300300
SpallationNeutronSource = 'Spallation Neutron Source'
301+
"""A spallation neutron source."""
301302
ReactorNeutronSource = 'Reactor Neutron Source'
303+
"""A reactor neutron source."""
302304
SynchrotronXraySource = 'Synchrotron X-ray Source'
305+
"""A synchrotron X-ray source."""
303306

304307

305-
class RadiationProbe(str, enum.Enum):
308+
class RadiationProbe(enum.Enum):
306309
"""Type of radiation probe.
307310
308311
Names are based on NeXus definitions.
309312
"""
310313

311314
Neutron = 'neutron'
315+
"""Neutron probe."""
312316
Xray = 'X-ray'
317+
"""X-ray probe."""
313318

314319

315320
class Source(BaseModel):

0 commit comments

Comments
 (0)