From c5839ca505f1980ea84b287a0a408b5167aabe24 Mon Sep 17 00:00:00 2001
From: Jonathan Wang <31040440+jonathanpwang@users.noreply.github.com>
Date: Wed, 15 Nov 2023 14:28:49 -0800
Subject: [PATCH] chore: fix docs

---
 halo2_proofs/src/circuit/value.rs    |  4 ++--
 halo2_proofs/src/dev.rs              |  2 +-
 halo2_proofs/src/dev/gates.rs        |  2 +-
 halo2_proofs/src/dev/graph/layout.rs |  2 +-
 halo2_proofs/src/dev/tfp.rs          |  2 +-
 halo2_proofs/src/lib.rs              |  5 ++++-
 halo2_proofs/src/plonk/circuit.rs    | 12 ++++++------
 7 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/halo2_proofs/src/circuit/value.rs b/halo2_proofs/src/circuit/value.rs
index f3ea6a39ea..ca4f7af71c 100644
--- a/halo2_proofs/src/circuit/value.rs
+++ b/halo2_proofs/src/circuit/value.rs
@@ -34,7 +34,7 @@ impl<V> Value<V> {
     /// # Examples
     ///
     /// ```
-    /// use halo2_proofs::circuit::Value;
+    /// use halo2_axiom::circuit::Value;
     ///
     /// let v = Value::known(37);
     /// ```
@@ -645,7 +645,7 @@ impl<V> Value<V> {
     /// If you have a `Value<F: Field>`, convert it to `Value<Assigned<F>>` first:
     /// ```
     /// # use halo2curves::pasta::pallas::Base as F;
-    /// use halo2_proofs::{circuit::Value, plonk::Assigned};
+    /// use halo2_axiom::{circuit::Value, plonk::Assigned};
     ///
     /// let v = Value::known(F::from(2));
     /// let v: Value<Assigned<F>> = v.into();
diff --git a/halo2_proofs/src/dev.rs b/halo2_proofs/src/dev.rs
index 05d2974b54..5de0b9dba0 100644
--- a/halo2_proofs/src/dev.rs
+++ b/halo2_proofs/src/dev.rs
@@ -198,7 +198,7 @@ impl<F: Field> Mul<F> for Value<F> {
 /// # Examples
 ///
 /// ```
-/// use halo2_proofs::{
+/// use halo2_axiom::{
 ///     circuit::{Layouter, SimpleFloorPlanner, Value},
 ///     dev::{FailureLocation, MockProver, VerifyFailure},
 ///     plonk::{Advice, Any, Circuit, Column, ConstraintSystem, Error, Selector},
diff --git a/halo2_proofs/src/dev/gates.rs b/halo2_proofs/src/dev/gates.rs
index 352415bcd9..ea68359229 100644
--- a/halo2_proofs/src/dev/gates.rs
+++ b/halo2_proofs/src/dev/gates.rs
@@ -29,7 +29,7 @@ struct Gate {
 ///
 /// ```
 /// use ff::Field;
-/// use halo2_proofs::{
+/// use halo2_axiom::{
 ///     circuit::{Layouter, SimpleFloorPlanner},
 ///     dev::CircuitGates,
 ///     plonk::{Circuit, ConstraintSystem, Error},
diff --git a/halo2_proofs/src/dev/graph/layout.rs b/halo2_proofs/src/dev/graph/layout.rs
index 3b243e3bd7..4163a43f05 100644
--- a/halo2_proofs/src/dev/graph/layout.rs
+++ b/halo2_proofs/src/dev/graph/layout.rs
@@ -21,7 +21,7 @@ use crate::{
 /// # Examples
 ///
 /// ```ignore
-/// use halo2_proofs::dev::CircuitLayout;
+/// use halo2_axiom::dev::CircuitLayout;
 /// use plotters::prelude::*;
 ///
 /// let drawing_area = BitMapBackend::new("example-circuit-layout.png", (1024, 768))
diff --git a/halo2_proofs/src/dev/tfp.rs b/halo2_proofs/src/dev/tfp.rs
index 094c8d6fb0..0579afe1cb 100644
--- a/halo2_proofs/src/dev/tfp.rs
+++ b/halo2_proofs/src/dev/tfp.rs
@@ -30,7 +30,7 @@ use crate::{
 ///
 /// ```ignore
 /// use ff::Field;
-/// use halo2_proofs::{
+/// use halo2_axiom::{
 ///     circuit::{floor_planner, Layouter, Value},
 ///     dev::TracingFloorPlanner,
 ///     plonk::{Circuit, ConstraintSystem, Error},
diff --git a/halo2_proofs/src/lib.rs b/halo2_proofs/src/lib.rs
index bd1d38d636..73420a20a1 100644
--- a/halo2_proofs/src/lib.rs
+++ b/halo2_proofs/src/lib.rs
@@ -1,4 +1,7 @@
-//! # halo2_proofs
+//! # halo2-axiom
+//! This is a fork of <https://github.com/privacy-scaling-explorations/halo2>, which is itself a fork of ZCash's "halo2_proofs" crate.
+//! This fork uses the KZG polynomial commitment scheme for the proving backend.
+//! Publishing this crate for better versioning in Axiom's production usage.
 
 #![cfg_attr(docsrs, feature(doc_cfg))]
 // The actual lints we want to disable.
diff --git a/halo2_proofs/src/plonk/circuit.rs b/halo2_proofs/src/plonk/circuit.rs
index 93897e8697..c7019a39e8 100644
--- a/halo2_proofs/src/plonk/circuit.rs
+++ b/halo2_proofs/src/plonk/circuit.rs
@@ -414,9 +414,9 @@ impl TryFrom<Column<Any>> for Column<Instance> {
 ///
 /// Selectors can be used to conditionally enable (portions of) gates:
 /// ```
-/// use halo2_proofs::poly::Rotation;
+/// use halo2_axiom::poly::Rotation;
 /// # use halo2curves::pasta::Fp;
-/// # use halo2_proofs::plonk::ConstraintSystem;
+/// # use halo2_axiom::plonk::ConstraintSystem;
 ///
 /// # let mut meta = ConstraintSystem::<Fp>::default();
 /// let a = meta.advice_column();
@@ -437,12 +437,12 @@ impl TryFrom<Column<Any>> for Column<Instance> {
 /// Selectors are disabled on all rows by default, and must be explicitly enabled on each
 /// row when required:
 /// ```
-/// use halo2_proofs::{
+/// use halo2_axiom::{
 ///     circuit::{Chip, Layouter, Value},
 ///     plonk::{Advice, Column, Error, Selector},
 /// };
 /// use ff::Field;
-/// # use halo2_proofs::plonk::Fixed;
+/// # use halo2_axiom::plonk::Fixed;
 ///
 /// struct Config {
 ///     a: Column<Advice>,
@@ -1410,9 +1410,9 @@ impl<F: Field> From<Expression<F>> for Vec<Constraint<F>> {
 /// A set of polynomial constraints with a common selector.
 ///
 /// ```
-/// use halo2_proofs::{plonk::{Constraints, Expression}, poly::Rotation};
+/// use halo2_axiom::{plonk::{Constraints, Expression}, poly::Rotation};
 /// use halo2curves::pasta::Fp;
-/// # use halo2_proofs::plonk::ConstraintSystem;
+/// # use halo2_axiom::plonk::ConstraintSystem;
 ///
 /// # let mut meta = ConstraintSystem::<Fp>::default();
 /// let a = meta.advice_column();