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

improve doc string for interface #944

Open
wants to merge 1 commit into
base: slashing-magnitudes
Choose a base branch
from

Conversation

non-fungible-nelson
Copy link

@non-fungible-nelson non-fungible-nelson commented Dec 11, 2024

Adding a new docstring that brings in context.

Copy link

Reading tracefile ./lcov.info.pruned
                                        |Lines       |Functions  |Branches    
Filename                                  |Rate     Num|Rate    Num|Rate     Num
================================================================================
[src/contracts/]
core/AVSDirectory.sol                     | 100%     23| 100%     7|    -      0
core/AllocationManager.sol                | 100%    291| 100%    41|    -      0
core/DelegationManager.sol                |96.4%    274|95.3%    43|    -      0
core/RewardsCoordinator.sol               |95.9%    218|92.9%    42|    -      0
core/StrategyManager.sol                  |96.7%     91|91.3%    23|    -      0
libraries/BeaconChainProofs.sol           | 100%     33| 100%    11|    -      0
libraries/BytesLib.sol                    | 0.0%    170| 0.0%    14|    -      0
libraries/Endian.sol                      | 100%      3| 100%     1|    -      0
libraries/Merkle.sol                      | 100%     43| 100%     5|    -      0
libraries/OperatorSetLib.sol              | 100%      4| 100%     2|    -      0
libraries/SlashingLib.sol                 | 100%     30| 100%    11|    -      0
libraries/Snapshots.sol                   |90.5%     42|88.9%     9|    -      0
mixins/PermissionControllerMixin.sol      | 100%      6| 100%     3|    -      0
mixins/SignatureUtils.sol                 | 100%     12| 100%     5|    -      0
permissions/Pausable.sol                  |93.3%     30|90.0%    10|    -      0
permissions/PauserRegistry.sol            | 100%     18| 100%     6|    -      0
permissions/PermissionController.sol      | 100%     73| 100%    17|    -      0
pods/EigenPod.sol                         |99.4%    155|96.3%    27|    -      0
pods/EigenPodManager.sol                  |99.0%     98|94.1%    17|    -      0
strategies/EigenStrategy.sol              | 0.0%     14| 0.0%     4|    -      0
strategies/StrategyBase.sol               |87.3%     63|78.9%    19|    -      0
strategies/StrategyBaseTVLLimits.sol      | 100%     17| 100%     5|    -      0
strategies/StrategyFactory.sol            | 100%     40| 100%     8|    -      0
token/BackingEigen.sol                    |79.1%     43|69.2%    13|    -      0
token/Eigen.sol                           |49.1%     53|61.5%    13|    -      0
================================================================================
                                  Total:|86.0%   1844|88.2%   356|    -      0

1 similar comment
Copy link

Reading tracefile ./lcov.info.pruned
                                        |Lines       |Functions  |Branches    
Filename                                  |Rate     Num|Rate    Num|Rate     Num
================================================================================
[src/contracts/]
core/AVSDirectory.sol                     | 100%     23| 100%     7|    -      0
core/AllocationManager.sol                | 100%    291| 100%    41|    -      0
core/DelegationManager.sol                |96.4%    274|95.3%    43|    -      0
core/RewardsCoordinator.sol               |95.9%    218|92.9%    42|    -      0
core/StrategyManager.sol                  |96.7%     91|91.3%    23|    -      0
libraries/BeaconChainProofs.sol           | 100%     33| 100%    11|    -      0
libraries/BytesLib.sol                    | 0.0%    170| 0.0%    14|    -      0
libraries/Endian.sol                      | 100%      3| 100%     1|    -      0
libraries/Merkle.sol                      | 100%     43| 100%     5|    -      0
libraries/OperatorSetLib.sol              | 100%      4| 100%     2|    -      0
libraries/SlashingLib.sol                 | 100%     30| 100%    11|    -      0
libraries/Snapshots.sol                   |90.5%     42|88.9%     9|    -      0
mixins/PermissionControllerMixin.sol      | 100%      6| 100%     3|    -      0
mixins/SignatureUtils.sol                 | 100%     12| 100%     5|    -      0
permissions/Pausable.sol                  |93.3%     30|90.0%    10|    -      0
permissions/PauserRegistry.sol            | 100%     18| 100%     6|    -      0
permissions/PermissionController.sol      | 100%     73| 100%    17|    -      0
pods/EigenPod.sol                         |99.4%    155|96.3%    27|    -      0
pods/EigenPodManager.sol                  |99.0%     98|94.1%    17|    -      0
strategies/EigenStrategy.sol              | 0.0%     14| 0.0%     4|    -      0
strategies/StrategyBase.sol               |87.3%     63|78.9%    19|    -      0
strategies/StrategyBaseTVLLimits.sol      | 100%     17| 100%     5|    -      0
strategies/StrategyFactory.sol            | 100%     40| 100%     8|    -      0
token/BackingEigen.sol                    |79.1%     43|69.2%    13|    -      0
token/Eigen.sol                           |49.1%     53|61.5%    13|    -      0
================================================================================
                                  Total:|86.0%   1844|88.2%   356|    -      0

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.

1 participant