Skip to content

Commit 9ec4086

Browse files
author
Joel Collins
committed
Minor terminology fixes
1 parent d108cff commit 9ec4086

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A Python implementation of the LabThings API structure, based on the Flask micro
1515

1616
## Quickstart example
1717

18-
This example assumes a `PretendSpectrometer` class, which already has `data` and `integration_time` properties, as well as an `average_data(n)` method. LabThings allows you to easily convert this existing instrument control code into a fully documented, standardised web API complete with auto-discovery and automatic background task threading.
18+
This example assumes a `PretendSpectrometer` class, which already has `data` and `integration_time` attributes, as well as an `average_data(n)` method. LabThings allows you to easily convert this existing instrument control code into a fully documented, standardised web API complete with auto-discovery and automatic background task threading.
1919

2020
```python
2121
from labthings import fields, create_app

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, an ``integration_time`` 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`` attribute which quickly returns a spectrum, an ``x_range`` attribute which determines the range of data we'll return, an ``integration_time`` attribute 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)