Skip to content

Commit

Permalink
Fix doctest problems
Browse files Browse the repository at this point in the history
  • Loading branch information
jl-wynen committed Jan 22, 2025
1 parent e13e982 commit cfeb945
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/scippneutron/meta/_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,16 @@ class Beamline(BaseModel):
The location of the beamline is split into ``facility`` and ``site``, where
a 'facility' is located at a 'site'. For example:
>>> Beamline(
>>> from scippneutron.meta import Beamline
>>> beamline = Beamline(
... name='Amor',
... facility='SINQ',
... site='PSI',
... )
If there is no separate facility and site, omit ``site``:
>>> Beamline(
>>> beamline = Beamline(
... name='ESTIA',
... facility='ESS',
... site=None, # can be omitted
Expand Down Expand Up @@ -196,7 +197,8 @@ class Software(BaseModel):
The piece of software should be specified as precisely as possible.
For example, a release version of ScippNeutron could be specified as follows:
>>> Software(
>>> from scippneutron.meta import Software
>>> software = Software(
... name='ScippNeutron',
... version='24.11.0',
... url='https://github.com/scipp/scippneutron/releases/tag/24.11.0',
Expand All @@ -208,7 +210,7 @@ class Software(BaseModel):
But the software should be specified as precisely as possible.
For example:
>>> Software(
>>> software = Software(
... name='ScippNeutron',
... version='24.11.1.dev8+g10d09ab0',
... url='https://github.com/scipp/scippneutron',
Expand Down

0 comments on commit cfeb945

Please sign in to comment.