Skip to content

docs: link to constructor methods in classes docs #4034

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 5 commits into
base: master
Choose a base branch
from

Conversation

ScottyPoi
Copy link
Contributor

@ScottyPoi ScottyPoi commented Apr 25, 2025

  1. Updates docs with links to constructor methods
  • Common
  • Blockchain
  • BinaryTree
  • MerklePatriciaTree
  • VerkleTree
  • VM
  • EVM
  1. Removes EVM from typedoc ignore list
  2. Rebuilds docs for whole monorepo

Copy link

codecov bot commented Apr 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.53%. Comparing base (060f690) to head (c611114).

Additional details and impacted files

Impacted file tree graph

Flag Coverage Δ
block 84.33% <ø> (ø)
blockchain 89.32% <ø> (ø)
client 67.99% <ø> (?)
common 97.51% <ø> (ø)
devp2p 86.78% <ø> (ø)
evm 73.11% <ø> (ø)
mpt 90.41% <ø> (+0.35%) ⬆️
statemanager 69.06% <ø> (ø)
static 99.11% <ø> (ø)
tx 89.89% <ø> (ø)
util 89.19% <ø> (ø)
vm 55.50% <ø> (ø)

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ScottyPoi ScottyPoi marked this pull request as ready for review April 25, 2025 19:20
Copy link
Contributor

@acolytec3 acolytec3 left a comment

Choose a reason for hiding this comment

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

This looks great. Will these changes get deleted next time we rebuild the docs?

@holgerd77
Copy link
Member

This looks great. Will these changes get deleted next time we rebuild the docs?

Ah, yes, for sure! @ScottyPoi can you please transfer these comments to its original places in the code itself, to make this sustainable?

@holgerd77
Copy link
Member

So, and for the evm/docs/classes/EVM.md file, if this file is not generated automatically, you need to investigate why this happens in the first place. The docs folders should just never be edited manually, this will always get overwritten by the npm run docs:build command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants