Skip to content

Commit d108cff

Browse files
author
Joel Collins
committed
Minor typos
1 parent 34116e5 commit d108cff

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/quickstart.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Quickstart
33

44
The easiest way to get started with Python-LabThings is via the :meth:`labthings.create_app` function, and the :class:`labthings.LabThing` builder methods.
55

6-
We will assume that for basic usage you already have some basic instrument control code. In our example, this is in the form of a ``PretendSpectrometer`` class, which will generate some data like your instrument control code might. Our ``PretendSpectrometer`` class has a ``data`` property which quickly returns a spectrum, an ``x_range`` property which determines the range of data we'll return, a ``magic_denoise`` property for cleaning up our signal, and a slow ``average_data(n)`` method to average ``n`` individual data measurements.
6+
We will assume that for basic usage you already have some basic instrument control code. In our example, this is in the form of a ``PretendSpectrometer`` class, which will generate some data like your instrument control code might. Our ``PretendSpectrometer`` class has a ``data`` property which quickly returns a spectrum, an ``x_range`` property which determines the range of data we'll return, an ``integration_time`` property for cleaning up our signal, and a slow ``average_data(n)`` method to average ``n`` individual data measurements.
77

88
Building an API from this class requires a few extra considerations. In order to tell our API what data to expect from users, we need to construct a schema for each of our interactions. This schema simply maps variable names to JSON-compatible types, and is made simple via the :mod:`labthings.fields` module.
99

0 commit comments

Comments
 (0)