Skip to content

docs(v2): operator #508

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

Open
wants to merge 12 commits into
base: v2-dev-2
Choose a base branch
from

Conversation

damiramirez
Copy link
Contributor

@damiramirez damiramirez commented May 16, 2025

What Changed?

Add documentation to operator/lib.rs.

Run with:

cargo doc -p eigen-operator --no-deps --open

Reviewer Checklist

  • New features are tested and documented
  • PR updates the changelog with a description of changes
  • PR has one of the changelog-X labels (if applies)
  • Code deprecates any old functionality before removing it

@damiramirez damiramirez changed the base branch from v2-dev-1 to v2-dev-2 May 19, 2025 14:48
@damiramirez damiramirez marked this pull request as ready for review May 19, 2025 14:49
Copy link
Collaborator

@MegaRedHand MegaRedHand left a comment

Choose a reason for hiding this comment

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

Great documentation!

@@ -32,6 +32,7 @@ rand_core.workspace = true
eigen-logging.workspace = true
eigen-crypto-bn254.workspace = true
eigen-utils.workspace = true
eigen-testing-utils.workspace = true
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's remove this dependency, since it's only used for docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ups, done 3d12688

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.

2 participants