Regenerated docs with types extraction fixes #1455
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
||
| ## Returns | ||
|
|
||
| `Promise<string>` |
There was a problem hiding this comment.
This doesn't seem correct 🤔, mind taking a look at this (love the params type above though -- so slick! 😎 )
There was a problem hiding this comment.
Implemented! I also updated codeblocks formatting in return types
There was a problem hiding this comment.
Pull Request Overview
This pull request regenerates documentation with fixes for types extraction. The changes standardize documentation formatting and correct file path references in auto-generated documentation comments.
- Updates quote style from single to double quotes throughout documentation
- Fixes file path references in auto-generated documentation comments (removing
/cadence/directory references) - Improves type formatting with better line breaks and spacing
- Fixes minor text issues like "onchain" to "on-chain"
Reviewed Changes
Copilot reviewed 80 out of 80 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/build/tools/clients/fcl-js/packages-docs/sdk/*.md | SDK documentation files with standardized quote formatting and corrected file path references |
| docs/build/tools/clients/fcl-js/packages-docs/fcl/*.md | FCL documentation files with similar formatting improvements and path corrections |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -93,7 +93,7 @@ A proposal key contains three fields: | |||
| - Key index | |||
| - Sequence number | |||
|
|
|||
| A transaction is only valid if its declared sequence number matches the current onchain sequence number for that key. The sequence number increments by one after the transaction is executed. | |||
| A transaction is only valid if its declared sequence number matches the current on-chain sequence number for that key. The sequence number increments by one after the transaction is executed. | |||
There was a problem hiding this comment.
Changed 'onchain' to 'on-chain' which is the correct hyphenated form when used as an adjective.
Copilot uses AI. Check for mistakes.
| --- | ||
|
|
||
| <!-- THIS DOCUMENT IS AUTO-GENERATED FROM [onflow/fcl/src/fcl.ts](https://github.com/onflow/fcl-js/tree/master/packages/fcl/src/fcl.ts). DO NOT EDIT MANUALLY --> | ||
|
|
||
| # mutate | ||
|
|
||
| A transaction execution function that allows you to submit Cadence transactions to the Flow blockchain | ||
| to mutate onchain state. This function handles the complete transaction lifecycle including building, signing, and | ||
| to mutate on-chain state. This function handles the complete transaction lifecycle including building, signing, and |
There was a problem hiding this comment.
Changed 'onchain' to 'on-chain' which is the correct hyphenated form when used as an adjective.
Copilot uses AI. Check for mistakes.
Closes onflow/fcl-js#2627