Skip to content

docs(v2): challenger #513

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 17 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 challenger/lib.rs.

Run:

cargo doc -p eigen-challenger --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 15:55
@damiramirez damiramirez marked this pull request as ready for review May 19, 2025 18:01
@@ -1,7 +1,7 @@
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
/// Configuration for the [`Challenger`]
/// Configuration for the `Challenger`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why was this removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Linking doesn’t seem to be working here

warning: unresolved link to `Challenger`
 --> crates/challenger/src/config.rs:4:29
  |
4 | /// Configuration for the [`Challenger`]
  |                             ^^^^^^^^^^ no item named `Challenger` in scope

Fixed 9087ebd

Copy link
Collaborator

Choose a reason for hiding this comment

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

Much better!

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