mp.c: Describe `MP' and `GF' conversion semantics.

[catacomb-python] / mp.c

diff --git a/mp.c b/mp.c
index e4f59804246862d6f71836b4a81fd1e7ac39ce52..62d2dfeee29a7d6323128ab2317b1303a8742ee6 100644 (file)
--- a/mp.c
+++ b/mp.c
@@ -892,11 +892,15 @@ static PyTypeObject mp_pytype_skel = {
 
   /* @tp_doc@ */
 "Multiprecision integers, similar to `long' but more efficient and\n\
 
   /* @tp_doc@ */
 "Multiprecision integers, similar to `long' but more efficient and\n\

-versatile.  Support all the standard arithmetic operations.\n\
+versatile.  Support all the standard arithmetic operations, with\n\
+implicit conversions from `PrimeFilter', and other objects which\n\
+convert to `long'.\n\

 \n\
 \n\

-Constructor mp(X, radix = R) attempts to convert X to an `mp'.  If\n\
+Constructor MP(X, radix = R) attempts to convert X to an `MP'.  If\n\

 X is a string, it's read in radix-R form, or we look for a prefix\n\
 X is a string, it's read in radix-R form, or we look for a prefix\n\

-if R = 0.  Other acceptable things are ints and longs.\n\
+if R = 0.  Other acceptable things are field elements, elliptic curve\n\
+points, group elements, Python `int' and `long' objects, and anything\n\
+with an integer conversion.\n\

 \n\
 Notes:\n\
 \n\
 \n\
 Notes:\n\
 \n\


@@ -2083,9 +2087,11 @@ static PyTypeObject gf_pytype_skel = {
 "Binary polynomials.  Support almost all the standard arithmetic\n\
 operations.\n\
 \n\
 "Binary polynomials.  Support almost all the standard arithmetic\n\
 operations.\n\
 \n\

-Constructor gf(X, radix = R) attempts to convert X to a `gf'.  If\n\
+Constructor GF(X, radix = R) attempts to convert X to a `GF'.  If\n\

 X is a string, it's read in radix-R form, or we look for a prefix\n\
 X is a string, it's read in radix-R form, or we look for a prefix\n\

-if R = 0.  Other acceptable things are ints and longs.\n\
+if R = 0.  Other acceptable things are field elements, elliptic curve\n\
+points, group elements, Python `int' and `long' objects, and anything\n\
+with an integer conversion.\n\

 \n\
 The name is hopelessly wrong from a technical point of view, but\n\
 but it's much easier to type than `p2' or `c2' or whatever.\n\
 \n\
 The name is hopelessly wrong from a technical point of view, but\n\
 but it's much easier to type than `p2' or `c2' or whatever.\n\