From a8e56110141eeaa16096f2bc8fff9fa89b6b56b9 Mon Sep 17 00:00:00 2001
From: RobertoRoos <robert.soor@gmail.com>
Date: Tue, 2 Jul 2024 16:17:13 +0200
Subject: [PATCH] Added note to Master.open() about interface names (#137)

---
 pysoem/pysoem.pyx | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/pysoem/pysoem.pyx b/pysoem/pysoem.pyx
index fd588dd..da8c2c4 100644
--- a/pysoem/pysoem.pyx
+++ b/pysoem/pysoem.pyx
@@ -210,9 +210,16 @@ cdef class CdefMaster:
         
     def open(self, ifname, ifname_red=None):
         """Initialize and open network interface.
-        
+
+        On Linux the name of the interface is the same as usd by the system, e.g. ``eth0``, and as displayed by
+        ``ip addr``.
+
+        On Windows the names of the interfaces look like ``\\Device\\NPF_{1D123456-1E12-1C12-12F1-1234E123453B}``.
+        Finding the kind of name that SOEM expects is not straightforward. The most practical way is to use the
+        :func:`~find_adapters` method to find your available interfaces.
+
         Args:
-            ifname(str): Interface name. (see find_adapters)
+            ifname(str): Interface name.
             ifname_red(:obj:`str`, optional): Interface name of the second network interface card for redundancy.
                 Put to None if not used.