Refactor rpc_method_wrapper docs to point to Web3Eth docs
#6054
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spacesailor24
requested review from
avkos,
jdevcs,
luu-alex,
Muhammad-Altabba and
nikoulai
as code owners
Bundle StatsHey there, this message comes from a github action that helps you and reviewers to understand how these changes affect the size of this project's bundle. As this PR is updated, I'll keep you updated on how the bundle size is impacted. Total
View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger No assets were bigger Smaller No assets were smaller Unchanged
|
Deploying with
|
| Latest commit: |
4775a3c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f0b16cb5.web3-js-docs.pages.dev |
| Branch Preview URL: | https://wyatt-4-x-5295-web3-eth-docs.web3-js-docs.pages.dev |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## 4.x #6054 +/- ##
=======================================
Coverage 85.97% 85.97%
=======================================
Files 157 157
Lines 7474 7474
Branches 2022 2022
=======================================
Hits 6426 6426
Misses 1048 1048
Flags with carried forward coverage won't be shown. Click here to find out more.
|
avkos
approved these changes
May 2, 2023
jdevcs
reviewed
May 2, 2023
|
LGTM, just need tiny change |
luu-alex
approved these changes
May 3, 2023
Co-authored-by: Junaid <86780488+jdevcs@users.noreply.github.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The issue requests to make use of
inheritDoc, but I couldn't get it to work across files. Additionally, a disclaimer utilizing Admonitions was requested to be added to each rpc method wrapper doc, but this functionality is only available in markdown files, not as doc strings. So, the only change in this PR is that the doc string for each rpc method wrapper links to the previously duplicate docs for each method found underWeb3Ethclass docscloses #5295