Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: minor tweaks... #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: minor tweaks... #25

wants to merge 1 commit into from

Conversation

NiloCK
Copy link

@NiloCK NiloCK commented Feb 7, 2023

  • replace unrendered $p$ bracketing with inline-code
  • floating numbers -> floating point numbers

Pull request checklist

Use the following template to make sure your PR fits the ConsenSys documentation standard.

Before creating the PR

Make sure that:

For tool changes:

  • Build and QA tools
  • MkDocs templates
  • MkDocs configuration
  • Python dependencies
  • Node dependencies and JavaScript
  • GitHub integration

After creating your PR and tests have finished

Make sure that:

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
- replace $p$ bracketing with inline-code
- floating numbers -> floating point numbers
@vercel
Copy link

vercel bot commented Feb 7, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
doc-gnark ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Feb 7, 2023 at 7:23PM (UTC)

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@NiloCK NiloCK changed the title minor tweaks... docs: minor tweaks... Feb 7, 2023
@@ -22,15 +22,15 @@ Refer to the conceptual documentation if you're not familiar with:

[`Circuits`](../../Concepts/circuits.md) are programmable but can't (practically and efficiently) prove any algorithm. The way constraints are represented make some things more natural ("snark-friendly") to do than others.

Numbers used in constraints are not integers or floats, but finite field elements (big numbers modulo a prime $p$).
Numbers used in constraints are not integers or floats, but finite field elements (big numbers modulo a prime `p`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previous version was actually correct, didn't render because the new doc didn't support Latex, fixed now 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants