Hi,
here's a patch that clarifies some docstrings a bit. Please take a look. I'll push to master if this is OK.
Thanks,
Phil
--047d7b5d43f8a463a9053a71ac9f--
--047d7b5d43f8a463ae053a71aca1
Content-Type: application/octet-stream;
name="0001-Some-assorted-documentation-clarifications.patch"
Content-Disposition: attachment;
filename="0001-Some-assorted-documentation-clarifications.patch"
Content-Transfer-Encoding: base64
Content-ID: <156a4446c3b324f9cad1>
X-Attachment-Id: 156a4446c3b324f9cad1
RnJvbSA3NWMyMDY3ZWNhMTJhNzg0YzU3Mjg2Yzc1MWIxN2NiZjFiZmRhNDdlIE1vbiBTZXAgMTcg
MDA6MDA6MDAgMjAwMQpGcm9tOiBQaGlsaXBwIFN0ZXBoYW5pIDxwaHN0QGdvb2dsZS5jb20+CkRh
dGU6IEZyaSwgMTkgQXVnIDIwMTYgMjE6MjM6MjQgKzAyMDAKU3ViamVjdDogW1BBVENIXSBTb21l
IGFzc29ydGVkIGRvY3VtZW50YXRpb24gY2xhcmlmaWNhdGlvbnMuCgoqIHNyYy9maWxlaW8uYyAo
RndyaXRlX3JlZ2lvbik6IENsYXJpZnkgdGhhdCBFTkQgaXMgaWdub3JlZCBpZgpTVEFSVCBpcyBu
aWwuCiogc3JjL2VkaXRmbnMuYyAoRmJ1ZmZlcl9zaXplKTogQWRkIHNob3J0IGRpc2N1c3Npb24g
YWJvdXQKbmFycm93aW5nLgoqIHNyYy9jYWxscHJvYy5jIChGY2FsbF9wcm9jZXNzX3JlZ2lvbik6
IERpc2N1c3MgYmVoYXZpb3Igd2hlbgpTVEFSVCBhbmQgRU5EIGFyZSBub3QgYnVmZmVyIHBvc2l0
aW9ucy4KLS0tCiBzcmMvY2FsbHByb2MuYyB8IDcgKysrKysrKwogc3JjL2VkaXRmbnMuYyAgfCA3
ICsrKysrKy0KIHNyYy9maWxlaW8uYyAgIHwgMyArKy0KIDMgZmlsZXMgY2hhbmdlZCwgMTUgaW5z
ZXJ0aW9ucygrKSwgMiBkZWxldGlvbnMoLSkKCmRpZmYgLS1naXQgYS9zcmMvY2FsbHByb2MuYyBi
L3NyYy9jYWxscHJvYy5jCmluZGV4IDQ4NzExNWQuLjQ1NGVkNmQgMTAwNjQ0Ci0tLSBhL3NyYy9j
YWxscHJvYy5jCisrKyBiL3NyYy9jYWxscHJvYy5jCkBAIC0xMDA0LDYgKzEwMDQsMTMgQEAgY3Jl
YXRlX3RlbXBfZmlsZSAocHRyZGlmZl90IG5hcmdzLCBMaXNwX09iamVjdCAqYXJncywKIERFRlVO
ICgiY2FsbC1wcm9jZXNzLXJlZ2lvbiIsIEZjYWxsX3Byb2Nlc3NfcmVnaW9uLCBTY2FsbF9wcm9j
ZXNzX3JlZ2lvbiwKICAgICAgICAzLCBNQU5ZLCAwLAogICAgICAgIGRvYzogLyogU2VuZCB0ZXh0
IGZyb20gU1RBUlQgdG8gRU5EIHRvIGEgc3luY2hyb25vdXMgcHJvY2VzcyBydW5uaW5nIFBST0dS
QU0uCisKK1NUQVJUIGFuZCBFTkQgYXJlIG5vcm1hbGx5IGJ1ZmZlciBwb3NpdGlvbnMgc3BlY2lm
eWluZyB0aGUgcGFydCBvZiB0aGUKK2J1ZmZlciB0byBzZW5kIHRvIHRoZSBwcm9jZXNzLgorSWYg
U1RBUlQgaXMgbmlsLCB0aGF0IG1lYW5zIHRvIHVzZSB0aGUgZW50aXJlIGJ1ZmZlciBjb250ZW50
czsgRU5EIGlzCitpZ25vcmVkLgorSWYgU1RBUlQgaXMgYSBzdHJpbmcsIHRoZW4gc2VuZCB0aGF0
IHN0cmluZyB0byB0aGUgcHJvY2VzcworaW5zdGVhZCBvZiBhbnkgYnVmZmVyIGNvbnRlbnRzOyBF
TkQgaXMgaWdub3JlZC4KIFRoZSByZW1haW5pbmcgYXJndW1lbnRzIGFyZSBvcHRpb25hbC4KIERl
bGV0ZSB0aGUgdGV4dCBpZiBmb3VydGggYXJnIERFTEVURSBpcyBub24tbmlsLgogCmRpZmYgLS1n
aXQgYS9zcmMvZWRpdGZucy5jIGIvc3JjL2VkaXRmbnMuYwppbmRleCA3MzIzMDZhLi40ZWZiNzZi
IDEwMDY0NAotLS0gYS9zcmMvZWRpdGZucy5jCisrKyBiL3NyYy9lZGl0Zm5zLmMKQEAgLTEwNjUs
NyArMTA2NSwxMiBAQCB1c2FnZTogKHNhdmUtY3VycmVudC1idWZmZXIgJnJlc3QgQk9EWSkgICov
KQogDAogREVGVU4gKCJidWZmZXItc2l6ZSIsIEZidWZmZXJfc2l6ZSwgU2J1ZmZlcl9zaXplLCAw
LCAxLCAwLAogICAgICAgIGRvYzogLyogUmV0dXJuIHRoZSBudW1iZXIgb2YgY2hhcmFjdGVycyBp
biB0aGUgY3VycmVudCBidWZmZXIuCi1JZiBCVUZGRVIsIHJldHVybiB0aGUgbnVtYmVyIG9mIGNo
YXJhY3RlcnMgaW4gdGhhdCBidWZmZXIgaW5zdGVhZC4gICovKQorSWYgQlVGRkVSIGlzIG5vdCBu
aWwsIHJldHVybiB0aGUgbnVtYmVyIG9mIGNoYXJhY3RlcnMgaW4gdGhhdCBidWZmZXIKK2luc3Rl
YWQuCisKK1RoaXMgZG9lcyBub3QgdGFrZSBuYXJyb3dpbmcgaW50byBhY2NvdW50OyB0byBjb3Vu
dCB0aGUgbnVtYmVyIG9mCitjaGFyYWN0ZXJzIGluIHRoZSBhY2Nlc3NpYmxlIHBvcnRpb24gb2Yg
dGhlIGJ1ZmZlciwgdXNlCivigJgoLSAocG9pbnQtbWF4KSAocG9pbnQtbWluKSnigJkuICAqLykK
ICAgKExpc3BfT2JqZWN0IGJ1ZmZlcikKIHsKICAgaWYgKE5JTFAgKGJ1ZmZlcikpCmRpZmYgLS1n
aXQgYS9zcmMvZmlsZWlvLmMgYi9zcmMvZmlsZWlvLmMKaW5kZXggMzc5NDhiYy4uYmY2YmY2MiAx
MDA2NDQKLS0tIGEvc3JjL2ZpbGVpby5jCisrKyBiL3NyYy9maWxlaW8uYwpAQCAtNDY1NCw3ICs0
NjU0LDggQEAgREVGVU4gKCJ3cml0ZS1yZWdpb24iLCBGd3JpdGVfcmVnaW9uLCBTd3JpdGVfcmVn
aW9uLCAzLCA3LAogV2hlbiBjYWxsZWQgZnJvbSBhIHByb2dyYW0sIHJlcXVpcmVzIHRocmVlIGFy
Z3VtZW50czoKIFNUQVJULCBFTkQgYW5kIEZJTEVOQU1FLiAgU1RBUlQgYW5kIEVORCBhcmUgbm9y
bWFsbHkgYnVmZmVyIHBvc2l0aW9ucwogc3BlY2lmeWluZyB0aGUgcGFydCBvZiB0aGUgYnVmZmVy
IHRvIHdyaXRlLgotSWYgU1RBUlQgaXMgbmlsLCB0aGF0IG1lYW5zIHRvIHVzZSB0aGUgZW50aXJl
IGJ1ZmZlciBjb250ZW50cy4KK0lmIFNUQVJUIGlzIG5pbCwgdGhhdCBtZWFucyB0byB1c2UgdGhl
IGVudGlyZSBidWZmZXIgY29udGVudHM7IEVORCBpcworaWdub3JlZC4KIElmIFNUQVJUIGlzIGEg
c3RyaW5nLCB0aGVuIG91dHB1dCB0aGF0IHN0cmluZyB0byB0aGUgZmlsZQogaW5zdGVhZCBvZiBh
bnkgYnVmZmVyIGNvbnRlbnRzOyBFTkQgaXMgaWdub3JlZC4KIAotLSAKMi45LjAKCg==
--047d7b5d43f8a463ae053a71aca1--