Skip to content

Commit 932b14f

Browse files
committed
Update some broken links and don't link to WoT Core Concepts so much.
1 parent c1b8e2c commit 932b14f

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

docs/source/actions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ terms, any method of a `.Thing` that we want to be able to call over HTTP
88
should be decorated as an Action, using `.thing_action`.
99

1010
This page gives an overview of how actions are implemented in LabThings-FastAPI.
11-
:ref:`wot_cc` includes a section on :ref:`wot_actions` that introduces the general concept.
11+
Our implementation should align with :ref:`wot_actions` as defined by the Web of Things standard.
1212

1313
Running actions via HTTP
1414
------------------------

src/labthings_fastapi/decorators/__init__.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
"""Mark the Interaction Affordances of a Thing.
22
3-
See :ref:`wot_cc` for definitions of Interaction Affordance and other terms.
4-
53
LabThings generates a :ref:`wot_td` to allow actions, properties, and
64
events to be used by client code. The descriptions of each "interaction
7-
affordance" rely on docstrings and Python type hints to provide a full
8-
description of the parameters, so it's important that you use these
9-
effectively.
5+
affordance" (see :ref:`wot_affordances`) rely on docstrings and Python
6+
type hints to provide a full description of the parameters, so it's
7+
important that you use these effectively.
108
119
If you have a complex datatype, it's recommended to use a `pydantic` model
1210
to describe it - this is often the case for complicated properties or events.

src/labthings_fastapi/thing.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""A class to represent hardware or software Things.
22
33
The `.Thing` class enables most of the functionality of this library,
4-
and is the way in to most of its features. See :ref:`wot_cc` and :ref:`labthings_cc`
5-
for more.
4+
and is the way in to most of its features. See :ref:`structure`
5+
for how it fits with the rest of the library.
66
"""
77

88
from __future__ import annotations

0 commit comments

Comments
 (0)