From 9c2102eae539577487437145dca417740d48e407 Mon Sep 17 00:00:00 2001
From: Michael Richardson <mcr@sandelman.ca>
Date: Tue, 5 Feb 2019 10:57:20 +0100
Subject: [PATCH] updated comments about documentation strings

---
 ext/openssl/ossl_x509name.c | 5 +++++
 ext/openssl/ossl_x509req.c  | 7 ++++++-
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/ext/openssl/ossl_x509name.c b/ext/openssl/ossl_x509name.c
index 1ea8400db..e2cb18fc9 100644
--- a/ext/openssl/ossl_x509name.c
+++ b/ext/openssl/ossl_x509name.c
@@ -333,6 +333,11 @@ ossl_x509name_inspect(VALUE self)
  *
  * Returns an Array representation of the distinguished name suitable for
  * passing to ::new
+ * The type code is an integer represents the string type.  Typical values include:
+ *   12 - UTF8STRING
+ *   19 - PRINTABLESTRING
+ * more values can be found, at, i.e:
+ *    https://docs.huihoo.com/doxygen/openssl/1.0.1c/crypto_2asn1_2asn1_8h.html
  */
 static VALUE
 ossl_x509name_to_a(VALUE self)
diff --git a/ext/openssl/ossl_x509req.c b/ext/openssl/ossl_x509req.c
index 2c20042a9..6a409f81f 100644
--- a/ext/openssl/ossl_x509req.c
+++ b/ext/openssl/ossl_x509req.c
@@ -318,7 +318,12 @@ ossl_x509req_sign(VALUE self, VALUE key, VALUE digest)
 }
 
 /*
- * Checks that cert signature is made with PRIVversion of this PUBLIC 'key'
+ * call-seq:
+ *    request.verify(pub_key) => true/false
+ *
+ * Validates the signature on the CSR.  The public key is usually found
+ * in request.public_key.
+ *
  */
 static VALUE
 ossl_x509req_verify(VALUE self, VALUE key)