From c0f909850bb2069c3e485d365b398996ad2db070 Mon Sep 17 00:00:00 2001
From: Mark Qvist
Date: Fri, 27 Aug 2021 19:54:57 +0200
Subject: [PATCH] Updated docs.
---
RNS/_version.py | 2 +-
docs/manual/.buildinfo | 2 +-
docs/manual/_static/documentation_options.js | 2 +-
docs/manual/examples.html | 6 +++---
docs/manual/genindex.html | 6 +++---
docs/manual/gettingstartedfast.html | 6 +++---
docs/manual/index.html | 6 +++---
docs/manual/reference.html | 21 +++++++++++---------
docs/manual/search.html | 6 +++---
docs/manual/searchindex.js | 2 +-
docs/manual/understanding.html | 6 +++---
docs/manual/whatis.html | 6 +++---
docs/source/conf.py | 2 +-
13 files changed, 38 insertions(+), 35 deletions(-)
diff --git a/RNS/_version.py b/RNS/_version.py
index 984fc57..4f7052b 100644
--- a/RNS/_version.py
+++ b/RNS/_version.py
@@ -1 +1 @@
-__version__ = "0.2.2"
\ No newline at end of file
+__version__ = "0.2.3"
\ No newline at end of file
diff --git a/docs/manual/.buildinfo b/docs/manual/.buildinfo
index 17e7f72..cddb72d 100644
--- a/docs/manual/.buildinfo
+++ b/docs/manual/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 966ae7177c1d48c9ee15971994c623b5
+config: 75fee65d4971d4f4b61034cb277ccd5b
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/manual/_static/documentation_options.js b/docs/manual/_static/documentation_options.js
index 65c3a7b..6914647 100644
--- a/docs/manual/_static/documentation_options.js
+++ b/docs/manual/_static/documentation_options.js
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
- VERSION: '0.2.2 beta',
+ VERSION: '0.2.3 beta',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
diff --git a/docs/manual/examples.html b/docs/manual/examples.html
index c50995c..6552a1f 100644
--- a/docs/manual/examples.html
+++ b/docs/manual/examples.html
@@ -5,7 +5,7 @@
-
This class.
destination – A RNS.Destination instance which to establish a link to.
established_callback – A function or method with the signature callback(link) to be called when the link has been established.
closed_callback – A function or method with the signature callback(link) to be called when the link is closed.
owner – Internal use by RNS.Transport, ignore this argument.
peer_pub_bytes – Internal use, ignore this argument.
peer_sig_pub_bytes – Internal use, ignore this argument.
Default timeout for link establishment in seconds.
Sends a request to the remote peer.
path – The request path.
response_callback – A function or method with the signature response_callback(request_receipt) to be called when a response is received. See the Request Example for more info.
failed_callback – A function or method with the signature failed_callback(request_receipt) to be called when a request fails. See the Request Example for more info.
response_callback – An optional function or method with the signature response_callback(request_receipt) to be called when a response is received. See the Request Example for more info.
failed_callback – An optional function or method with the signature failed_callback(request_receipt) to be called when a request fails. See the Request Example for more info.
timeout – An optional timeout in seconds for the request. If None is supplied, this defaults to RNS.Packet.TIMEOUT
.
The Resource class allows transferring arbitrary amounts of data over a link. It will automatically handle sequencing, compression, coordination and checksumming.
@@ -1144,7 +1147,7 @@ will announce it.