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

doc generation for viem to account ledger #390

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

aaronmgdr
Copy link
Member

@aaronmgdr aaronmgdr commented Oct 10, 2024

Description

It looks like our new package was not included in docs.

Other changes

I narrowed which files were included in docs to just the functions and constants actually exported publically

Tested


PR-Codex overview

This PR focuses on enhancing the @celo/viem-account-ledger library by updating type definitions, improving documentation, and modifying the CI workflow to include all package directories.

Detailed summary

  • Updated Hex type definition in types.ts.
  • Added module documentation in modules.md.
  • Updated typedoc.json to include README and entry points.
  • Modified CI workflow to track all package directories.
  • Changed LedgerAccount type to be exported in ledger-to-account.ts.
  • Added detailed documentation for ledgerToAccount function.
  • Enhanced README with installation and usage instructions.
  • Created detailed module documentation for ledger-to-account.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

changeset-bot bot commented Oct 10, 2024

⚠️ No Changeset found

Latest commit: f7a1f37

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

Copy link

codecov bot commented Oct 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.22%. Comparing base (576f902) to head (f7a1f37).
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #390   +/-   ##
=======================================
  Coverage   67.22%   67.22%           
=======================================
  Files         291      291           
  Lines       10972    10972           
  Branches     1534     1556   +22     
=======================================
  Hits         7376     7376           
+ Misses       3507     3503    -4     
- Partials       89       93    +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aaronmgdr aaronmgdr marked this pull request as ready for review October 10, 2024 14:55
@aaronmgdr aaronmgdr requested a review from a team as a code owner October 10, 2024 14:55
@aaronmgdr aaronmgdr merged commit c0c1644 into master Oct 14, 2024
36 of 48 checks passed
@aaronmgdr aaronmgdr deleted the aaronmgdr/viem-ledger-docs branch October 14, 2024 14:05
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