From 117012d8a734440fd6dd9b6f66af273f5e3acd72 Mon Sep 17 00:00:00 2001
From: Daniel Huppmann <dh@dergelbesalon.at>
Date: Wed, 18 Dec 2024 11:42:04 +0100
Subject: [PATCH] Add directional regions to the docs

---
 docs/user_guide/region.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/user_guide/region.rst b/docs/user_guide/region.rst
index 0ba316e2..0a323921 100644
--- a/docs/user_guide/region.rst
+++ b/docs/user_guide/region.rst
@@ -22,6 +22,20 @@ Regions can have attributes, for example a description or ISO3-codes. If the att
 `iso3_codes` is provided, the item(s) are validated against a list of valid codes taken
 from the `pycountry <https://github.com/flyingcircusio/pycountry>`_ package.
 
+Directional data
+----------------
+
+For reporting of directional data (e.g., trade flows), "directional regions" can be
+defined using a *>* separator. The region before the separator is the *origin*,
+the region after the separator is the *destination*.
+
+.. code:: yaml
+
+   - Trade Connections:
+     - China>Europe
+
+Both the origin and destination regions must be defined in the region codelist.
+
 Common regions
 --------------