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

Add a section to Michelson Encoder doc about the breaking change, fix TypeCheck method example #3002

Merged
merged 3 commits into from
Jul 8, 2024

Conversation

ac10n
Copy link
Contributor

@ac10n ac10n commented Jun 25, 2024

Closes #2969

  • Your code builds cleanly without any errors or warnings
  • You have run the linter against the changes
  • You have added unit tests (if relevant/appropriate)
  • You have added integration tests (if relevant/appropriate)
  • All public methods or types have TypeDoc coverage with a complete description, and ideally an @example
  • You have added or updated corresponding documentation
  • If relevant, you have written a first draft summary describing the change for inclusion in Release Notes.

In this PR, please also make sure:

  • You have linked this PR to the issue by putting closes #TICKETNUMBER in the description box (when applicable)
  • You have added a concise description on your changes

Release Note Draft Snippet

If relevant, please write a summary of your change that will be suitable for
inclusion in the Release Notes for the next Taquito release.

Copy link

github-actions bot commented Jun 25, 2024

A new deploy preview is available on Cloudflare Pages at https://321bee40.taquito-test-dapp.pages.dev

Copy link

github-actions bot commented Jun 25, 2024

New packages have been deployed to the preview repository at https://npm.preview.tezostaquito.io/.

Published packages:

npm i @taquito/http-utils@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/ledger-signer@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/timelock@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/local-forging@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/rpc@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/beacon-wallet@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/taquito@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/michelson-encoder@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/michel-codec@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/sapling@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/signer@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/contracts-library@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/tzip12@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/utils@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/tzip16@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/remote-signer@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/
npm i @taquito/core@20.0.1-5d4d927-- --registry https://npm.preview.tezostaquito.io/

Copy link

cloudflare-workers-and-pages bot commented Jun 25, 2024

Deploying taquito with  Cloudflare Pages  Cloudflare Pages

Latest commit: caa214e
Status: ✅  Deploy successful!
Preview URL: https://b0b3adc3.taquito.pages.dev
Branch Preview URL: https://2969-update-michelson-encode.taquito.pages.dev

View logs

}
}
```
You can enable the old behavior by setting the `Token.fieldNumberingStrategy = 'Legacy'`. Please not that this value should stay the same for the whole application.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo 'please not'

}
}
```
You can enable the old behavior by setting the `Token.fieldNumberingStrategy = 'Legacy'`. Please not that this value should stay the same for the whole application.
Copy link
Contributor

Choose a reason for hiding this comment

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

same typo here "please not"


Please run the code above and check the output.

Please note how nested field numbers are not predictable. The field numbers are assigned in the order their parent were encountered during the traversal of the tree.
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like these sentences can be improved a little bit, I think I understand them because I have context. Maybe something like

Please note that nested field numbers are unpredictable. Field numbers are assigned in the order of where their parent is encountered during the traversal of the tree.

What do you think?

Copy link
Contributor

@dsawali dsawali left a comment

Choose a reason for hiding this comment

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

lgtm, thanks Ali

@ac10n ac10n merged commit 22d8aea into master Jul 8, 2024
8 of 9 checks passed
@ac10n ac10n deleted the 2969-update-michelson-encoder-docs branch July 8, 2024 16:47
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.

Update MichelsonEncoder document, informing users of the breaking changes
2 participants