Update docs

OpShin · Feb 9, 2024 · bed48d1 · bed48d1
1 parent f4a65d0
commit bed48d1
Show file tree

Hide file tree

Showing 10 changed files with 783 additions and 78 deletions.
diff --git a/docs/index.js b/docs/index.js
@@ -2326,6 +2326,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.tests.test_misc.MiscTest.test_id_map_equals_pycardano",
+"url":8,
+"doc":"",
+"func":1
+},
+{
 "ref":"opshin.tests.test_ops",
 "url":9,
 "doc":""
@@ -4372,6 +4378,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.FunctionType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.TypeInferenceError",
 "url":24,
 "doc":"Assertion failed."
@@ -4448,6 +4460,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.Type.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.Record",
 "url":24,
 "doc":"Record(name: str, orig_name: str, constructor: int, fields: Union[List[Tuple[str, opshin.types.Type , frozenlist2.frozenlist])"
@@ -4544,11 +4562,23 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.ClassType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.AnyType",
 "url":24,
 "doc":"The top element in the partial order on types (excluding FunctionTypes, which do not compare to anything)"
 },
 {
+"ref":"opshin.types.AnyType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.AnyType.attribute_type",
 "url":24,
 "doc":"The types of the named attributes of this class",
@@ -4686,6 +4716,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.AtomicType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.RecordType",
 "url":24,
 "doc":"RecordType(record: opshin.types.Record)"
@@ -4696,6 +4732,12 @@ INDEX=[
 "doc":""
 },
 {
+"ref":"opshin.types.RecordType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.RecordType.constr_type",
 "url":24,
 "doc":"The type of the constructor for this class",
@@ -4772,6 +4814,12 @@ INDEX=[
 "doc":""
 },
 {
+"ref":"opshin.types.UnionType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.UnionType.attribute_type",
 "url":24,
 "doc":"The types of the named attributes of this class",
@@ -4914,6 +4962,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.TupleType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.PairType",
 "url":24,
 "doc":"An internal type representing built-in PlutusData pairs"
@@ -4995,6 +5049,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.PairType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.ListType",
 "url":24,
 "doc":"ListType(typ: opshin.types.Type)"
@@ -5005,6 +5065,12 @@ INDEX=[
 "doc":""
 },
 {
+"ref":"opshin.types.ListType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.ListType.attribute_type",
 "url":24,
 "doc":"The types of the named attributes of this class",
@@ -5086,6 +5152,12 @@ INDEX=[
 "doc":""
 },
 {
+"ref":"opshin.types.DictType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.DictType.attribute_type",
 "url":24,
 "doc":"The types of the named attributes of this class",
@@ -5162,6 +5234,12 @@ INDEX=[
 "doc":""
 },
 {
+"ref":"opshin.types.InstanceType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.InstanceType.constr_type",
 "url":24,
 "doc":"The type of the constructor for this class",
@@ -5233,6 +5311,12 @@ INDEX=[
 "doc":"IntegerType()"
 },
 {
+"ref":"opshin.types.IntegerType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.IntegerType.constr_type",
 "url":24,
 "doc":"The type of the constructor for this class",
@@ -5370,11 +5454,23 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.StringType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.ByteStringType",
 "url":24,
 "doc":"ByteStringType()"
 },
 {
+"ref":"opshin.types.ByteStringType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.ByteStringType.constr_type",
 "url":24,
 "doc":"The type of the constructor for this class",
@@ -5512,6 +5608,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.BoolType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.UnitType",
 "url":24,
 "doc":"UnitType()"
@@ -5583,6 +5685,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.UnitType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.InaccessibleType",
 "url":24,
 "doc":"A type that blocks overwriting of a function"
@@ -5654,6 +5762,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.InaccessibleType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.repeated_addition",
 "url":24,
 "doc":"",
@@ -5839,6 +5953,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.types.PolymorphicFunctionType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.PolymorphicFunctionInstanceType",
 "url":24,
 "doc":"PolymorphicFunctionInstanceType(typ: opshin.types.FunctionType, polymorphic_function: opshin.types.PolymorphicFunction)"
@@ -5854,6 +5974,12 @@ INDEX=[
 "doc":""
 },
 {
+"ref":"opshin.types.PolymorphicFunctionInstanceType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.types.PolymorphicFunctionInstanceType.constr_type",
 "url":24,
 "doc":"The type of the constructor for this class",
@@ -7347,6 +7473,12 @@ INDEX=[
 "func":1
 },
 {
+"ref":"opshin.rewrite.rewrite_import_hashlib.HashType.id_map",
+"url":24,
+"doc":"Returns a map from the constructor id to a descriptive typestring",
+"func":1
+},
+{
 "ref":"opshin.rewrite.rewrite_import_hashlib.PythonHashlib",
 "url":48,
 "doc":"An enumeration."