Skip to content

docs: Remove runtime target from docstrings#1757

Merged
smartcontracts merged 1 commit intoethereum-optimism:developfrom
coreyar:issue-1710-review-contract-docstrings-for-missing-descriptions
Nov 17, 2021
Merged

docs: Remove runtime target from docstrings#1757
smartcontracts merged 1 commit intoethereum-optimism:developfrom
coreyar:issue-1710-review-contract-docstrings-for-missing-descriptions

Conversation

@coreyar
Copy link
Copy Markdown
Contributor

@coreyar coreyar commented Nov 12, 2021

Description
Remove runtime target from doc strings and identify contracts with missing descriptions

Additional context
Contracts in the contracts package with missing descriptions are:

packages/contracts/L2/predeploys/WETH9.sol
packages/contracts/libraries/resolver/Lib_AddressManager.sol
packages/contracts/libraries/resolver/Lib_AddressResolver.
packages/contracts/libraries/resolver/Lib_ResolvedDelegateProxy.sol
packages/contracts/standards/L2StandardERC20.sol
packages/contracts/test-helpers/Helper_GasMeasurer.sol
packages/contracts/test-helpers/Helper_SimpleProxy.sol
packages/contracts/test-helpers/TestERC20.sol
packages/contracts/test-libraries/codec/TestLib_OVMCodec.sol
packages/contracts/contracts/test-libraries/rlp/TestLib_RLPReader.sol
packages/contracts/contracts/test-libraries/rlp/TestLib_RLPWriter.sol
packages/contracts/contracts/test-libraries/standards/TestLib_AddressAliasHelper.sol
packages/contracts/contracts/test-libraries/trie/TestLib_MerkleTrie.sol
packages/contracts/contracts/test-libraries/trie/TestLib_SecureMerkleTrie.sol
packages/contracts/contracts/test-libraries/utils/TestLib_Buffer.sol
packages/contracts/contracts/test-libraries/utils/TestLib_Bytes32Utils.sol
packages/contracts/contracts/test-libraries/utils/TestLib_BytesUtils.sol
packages/contracts/contracts/test-libraries/utils/TestLib_MerkleTree.sol

Metadata

@coreyar
docs: Remove runtime target from docstrings
6973a39 
The run time target is captured by the folder structure of the contracts package
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Nov 12, 2021

⚠️ No Changeset found

Latest commit: 6973a39

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Nov 12, 2021 •
edited
Loading

Codecov Report

Merging #1757 (6973a39) into develop (12b153a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1757   +/-   ##
========================================
  Coverage    71.81%   71.81%           
========================================
  Files           69       69           
  Lines         2303     2303           
  Branches       344      344           
========================================
  Hits          1654     1654           
  Misses         649      649
Flag Coverage Δ
batch-submitter 61.56% <ø> (ø)
contracts 87.96% <ø> (ø)
core-utils 56.53% <ø> (ø)
data-transport-layer 38.23% <ø> (ø)
message-relayer 70.86% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
.../contracts/L1/messaging/L1CrossDomainMessenger.sol 96.77% <ø> (ø)
...tracts/contracts/L1/messaging/L1StandardBridge.sol 97.05% <ø> (ø)
.../contracts/L1/rollup/CanonicalTransactionChain.sol 86.66% <ø> (ø)
...acts/contracts/L1/rollup/ChainStorageContainer.sol 70.00% <ø> (ø)
...racts/contracts/L1/rollup/StateCommitmentChain.sol 87.50% <ø> (ø)
...ontracts/contracts/L1/verification/BondManager.sol 100.00% <ø> (ø)
.../contracts/libraries/bridge/CrossDomainEnabled.sol 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 12b153a...6973a39. Read the comment docs.

@smartcontracts smartcontracts merged commit 42ae8e3 into ethereum-optimism:develop Nov 17, 2021
theochap pushed a commit that referenced this pull request Dec 10, 2025
@clabby
perf(engine): Batch safe-head FCUs (#1937)
5887f40 
## Overview

Updates the consolidate task to only send a forkchoice update for safe
head promotion if the attributes are either derived from a
`SingleBatch`, or if the attributes are the last attributes within a
`SpanBatch`.

closes #1757
theochap pushed a commit that referenced this pull request Jan 14, 2026
@clabby
perf(engine): Batch safe-head FCUs (op-rs/kona#1937)
4ccfc3e 
## Overview

Updates the consolidate task to only send a forkchoice update for safe
head promotion if the attributes are either derived from a
`SingleBatch`, or if the attributes are the last attributes within a
`SpanBatch`.

closes #1757
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tynes tynes tynes approved these changes

@smartcontracts smartcontracts smartcontracts approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Review contract docstrings for missing descriptions

4 participants

@coreyar @codecov-commenter @tynes @smartcontracts