[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[tor-commits] [stem/master] Fix broken parameter declarations
commit 08aeccdf890d8ba92794a734f34e2e93cd3e3219
Author: Damian Johnson <atagar@xxxxxxxxxxxxxx>
Date: Tue May 12 17:02:06 2020 -0700
Fix broken parameter declarations
Parameter declarations are of the form...
:param type variable_name: description
We wrap long lines, but it turns out that the ":param type variable_name:"
portion must reside on a single line or Sphinx emits the following warnings...
/home/atagar/Desktop/stem/stem/descriptor/hidden_service.py:docstring of stem.descriptor.hidden_service.HiddenServiceDescriptorV3.content:29: WARNING: Field list ends without a blank line; unexpected unindent.
/home/atagar/Desktop/stem/stem/descriptor/hidden_service.py:docstring of stem.descriptor.hidden_service.HiddenServiceDescriptorV3.content:33: WARNING: Definition list ends without a blank line; unexpected unindent.
---
stem/descriptor/hidden_service.py | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py
index 2eb7d02f..84e8e9c0 100644
--- a/stem/descriptor/hidden_service.py
+++ b/stem/descriptor/hidden_service.py
@@ -964,10 +964,10 @@ class HiddenServiceDescriptorV3(HiddenServiceDescriptor):
encrypted layer
:param stem.descriptor.hidden_service.OuterLayer outer_layer: outer
encrypted layer
- :param cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey
- identity_key: service identity key
- :param cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey
- signing_key: service signing key
+ :param cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey identity_key:
+ service identity key
+ :param cryptography.hazmat.primitives.asymmetric.ed25519.Ed25519PrivateKey signing_key:
+ service signing key
:param stem.descriptor.Ed25519CertificateV1 signing_cert: certificate
signing this descriptor
:param int revision_counter: descriptor revision number
_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits