From 4d8c53837381cacfa259b20de65d3f58cb936cda Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Mon, 25 Mar 2024 09:33:26 -0400 Subject: [PATCH] [DATALAD RUNCMD] run codespell throughout fixing typos automagically === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- docs/dev/app_dev.rst | 2 +- docs/info/faqs.rst | 4 ++-- docs/info/lslapicfg.rst | 6 +++--- docs/info/network-connectivity.rst | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/dev/app_dev.rst b/docs/dev/app_dev.rst index 64bb072..4fab755 100644 --- a/docs/dev/app_dev.rst +++ b/docs/dev/app_dev.rst @@ -20,7 +20,7 @@ effective for most cases: * It is encouraged that the metadata conforms to `the XDF specifications `_ * Create the outlet * In a loop (in a thread), or via a callback: - * Retrive data from the device + * Retrieve data from the device * Push data to the outlet See :doc:`examples` for links to small examples of code, diff --git a/docs/info/faqs.rst b/docs/info/faqs.rst index d2222c0..84b79f2 100644 --- a/docs/info/faqs.rst +++ b/docs/info/faqs.rst @@ -60,7 +60,7 @@ It is also possible to transmit raw structs, but note that this is generally unsafe and non-portable (e.g., different compilers insert varying amount of padding between struct elements; also on platforms with different endianness your data will be garbled). -An exception to this is sending numpy structs with explicitely set endianness +An exception to this is sending numpy structs with explicitly set endianness for all fields. In principle you can also send multiple streams and use the same time stamp @@ -266,7 +266,7 @@ has multiple packages, generally called Android also has ``.so`` shared objects, but has a different toolchain and architecture so the binaries (even if they're also named - :file:`liblsl.so`) are **not** interchangable with ``.so`` files for regular + :file:`liblsl.so`) are **not** interchangeable with ``.so`` files for regular Linuxes. .. warning diff --git a/docs/info/lslapicfg.rst b/docs/info/lslapicfg.rst index d5ce39d..ea2de56 100644 --- a/docs/info/lslapicfg.rst +++ b/docs/info/lslapicfg.rst @@ -94,7 +94,7 @@ corrections to the default settings). OrganizationAddresses = {} ; old = {239.192.172.215, FF08:113D:6FDD:2C17:A643:FFE2:1BD1:3CD2} GlobalAddresses = {} - ; This allows you to override the addresses calculated by VisibilityScope. To communicate conveniently wth a remote party without negotiating + ; This allows you to override the addresses calculated by VisibilityScope. To communicate conveniently with a remote party without negotiating ; the involved hostnames, you may choose a privately agreed-on multicast address of the appropriate scope here. AddressesOverride = {} @@ -103,14 +103,14 @@ corrections to the default settings). TTLOverride = -1 [lab] - ; This setting mainly serves as a fallback in case that your network configuration does not permit multicast/broadcast communciation. + ; This setting mainly serves as a fallback in case that your network configuration does not permit multicast/broadcast communication. ; By listing the names or IP addresses of your lab's machines here (both stream providers and stream users) and make the file available ; on all involved machines, you can bypass the need for multicasting. This setting can also be used to link a small collection of machines ; across the internet, provided that the firewall settings of each party permit communication (forward the BasePort to BasePort+PortRange ports). KnownPeers = {} ; This is the default "vanilla" session id; modify it to logically isolate your recording acitities from others within the scope. - ; The session id should not be relied on as a "password" to hide one's data from unpriviledged users; use operating-system and + ; The session id should not be relied on as a "password" to hide one's data from unprivileged users; use operating-system and ; network settings for this purpose. Note that you machine still gets to see some traffic from other activities if within the scope. SessionID = default diff --git a/docs/info/network-connectivity.rst b/docs/info/network-connectivity.rst index 3d55a99..f156867 100644 --- a/docs/info/network-connectivity.rst +++ b/docs/info/network-connectivity.rst @@ -202,7 +202,7 @@ you're in the file, make sure the :samp:`SessionID` setting is something other t debugging and courtesy purposes. Distribute this configuration file between the outlet and inlet and *make sure the -directory and file names are correct per your OS distrubution.* **If the name of the file is +directory and file names are correct per your OS distribution.* **If the name of the file is not exactly :samp:`lsl_api.cfg`, liblsl will not read it.** Finally to test that a remote connection is established, use a outlet/inlet