2922 michel codec doc #2972

hui-an-yang · 2024-05-24T05:59:05Z

adding michel codec documentation page to website
closes #2922

Thank you for your contribution to Taquito.

Before submitting this PR, please make sure:

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.

…2-michel-codec-doc

github-actions · 2024-05-24T06:01:22Z

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

github-actions · 2024-05-24T06:02:26Z

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

Published packages:

npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/
npm i @taquito/[email protected] --registry https://npm.preview.tezostaquito.io/

dsawali · 2024-05-27T18:47:18Z

docs/michel_codec.md

+const p = new Parser(parserOptions);
+```
+
+### parseJSON & emitMicheline - Parse JSON Michelson and convert it to Micheline


redundant title, remove 'parseJSON & emitMicheline`

they are in place so the outline of the doc display the function names

you listed them right below it, I would remove it

Heading titles for documentation should be concise and clear

also having the title of methods as a preface to what it does is not a very good habit when writing technical documentation (it does work in some exceptions, but not in this case)

When writing a heading for a section, you want to explain what this section describes:

Parsing JSON Michelson and converting to Micheline

and then you would describe what methods to use in the content of said section

i did some reading on writing technical docs outlines and it says it's good idea to have both method name with concise description and I also reference ethereum taquito equivalent tool docs, their outline have method name only. I think this is a preference and i decided to keep them.

dsawali · 2024-05-27T18:47:34Z

docs/michel_codec.md

+  .catch((error) => println(`Error: ${JSON.stringify(error, null, 2)}`));
+```
+
+### parseMichelineExpression - Parse Micheline and convert it to JSON Michelson


same here, remove 'parseMichelineExpression - '

dsawali · 2024-05-27T18:47:39Z

docs/michel_codec.md

+
+## PACK and UNPACK locally
+
+### packData & packDataBytes - Pack Michelson data


dsawali · 2024-05-27T18:47:45Z

docs/michel_codec.md

+// { bytes: "050a0000001901be41ee922ddd2cf33201e49d32da0afec571dce300666f6f" }
+```
+
+### unpackData & unpackDataBytes - Unpack Michelson data


dsawali · 2024-05-27T18:51:37Z

docs/michel_codec.md

+
+### packData & packDataBytes - Pack Michelson data
+`packData` & `packDataBytes` serialize any value of packable type to its optimized binary representation identical to the one used by PACK Michelson instructions.
+Without a type definition (not recommended) the data will be encoded as a binary form of a generic Michelson expression.


Missing comma after '(not recommended)'.

dsawali · 2024-05-27T18:53:53Z

docs/michel_codec.md

+```
+
+### unpackData & unpackDataBytes - Unpack Michelson data
+Deserialize a byte array into the corresponding Michelson value.


*Deserializes a byte array into *its corresponding Michelson value

grammarly compliants Deserializes but i've updated *its corresponding Michelson value

it is grammatically correct in this context since it's referring to a previous statement

it is akin to saying 'This method deserializes...'

you wouldn't say 'This method deserialize..'

deserialize should work too, but just pointing out that testing that sentence in grammarly will obviously output an error due to the false premise

Complete sentence will be "unpackData & unpackDataBytes deserialize..."

dsawali · 2024-05-27T18:54:14Z

docs/michel_codec.md

+
+### unpackData & unpackDataBytes - Unpack Michelson data
+Deserialize a byte array into the corresponding Michelson value.
+Without a type definition (not recommended) the binary data will be treated as a binary form of a generic Michelson expression and returned as is.


missing comma after parentheses

dsawali · 2024-05-27T18:56:30Z

docs/michel_codec.md

+author: Hui-An Yang
+---
+
+The purpose of the `taquito/michel-codec` package is to convert and validate Michelson expressions between JSON-based Michelson and Micheline. This package also comes with functions like `packData`, `packDataBytes`, `unpackData` and `unpackDataBytes` to serialize any value of packable type to its optimized binary representation locally and vice versa, like Michelson instructions `PACK` and `UNPACK`.


I recommend writing in an active tense. for example:

The `taquito/michel-codec` package converts and validates Michelson expressions between JSON-based Michelson and Micheline. It comes with various functions like.....

dsawali · 2024-05-27T18:59:59Z

docs/michel_codec.md

+The purpose of the `taquito/michel-codec` package is to convert and validate Michelson expressions between JSON-based Michelson and Micheline. This package also comes with functions like `packData`, `packDataBytes`, `unpackData` and `unpackDataBytes` to serialize any value of packable type to its optimized binary representation locally and vice versa, like Michelson instructions `PACK` and `UNPACK`.
+
+## Parser class
+To use the parser class as is, we import it from the package and initialize it.


*To use the parser class, import it as follows

not necessary to say as is, you expanded the parameters below.

we also add a very clear example right below it, so just point to the example instead of mentioning it in text

dsawali · 2024-05-27T19:01:14Z

docs/michel_codec.md

+const p = new Parser()
+```
+### Configuration
+If you'd like to customize the parser class to `expandMacros` or `expandGlobalConstant,` you can configure its `ParserOptions` through initialization.


I'd recommend saying something like, 'You can pass parameters to the parser class to blablabla' instead of 'customizing' the parser class. Customizing implies something like the taquito-http-util customization. This is just extra params.

can you elaborate the difference of extra params and customize?

customize would be to modify the method, refer to this doc https://taquito.io/docs/next/cancel_http_requests

update to this "You can configure the parser class by passing ParserOptions through initialization with expandMacros and expandGlobalConstant properties."

cloudflare-workers-and-pages · 2024-05-27T21:57:43Z

Deploying taquito with Cloudflare Pages

Latest commit:	`6010777`
Status:	✅ Deploy successful!
Preview URL:	https://3096d0bc.taquito.pages.dev
Branch Preview URL:	https://2922-michel-codec-doc.taquito.pages.dev

View logs

dsawali

some comments not yet addressed

hui-an-yang added 30 commits November 7, 2023 14:55

Merge branch 'master' of https://github.com/ecadlabs/taquito

81f82f7

Merge branch 'master' of https://github.com/ecadlabs/taquito

eab82bb

Merge branch 'master' of https://github.com/ecadlabs/taquito

0259cdd

Merge branch 'master' of https://github.com/ecadlabs/taquito

b1a2679

Merge branch 'master' of https://github.com/ecadlabs/taquito

45223bd

Merge branch 'master' of https://github.com/ecadlabs/taquito

a82b5cd

Merge branch 'master' of https://github.com/ecadlabs/taquito

3b08821

Merge branch 'master' of https://github.com/ecadlabs/taquito

bfd1f49

Merge branch 'master' of https://github.com/ecadlabs/taquito

5d0a7cc

Merge branch 'master' of https://github.com/ecadlabs/taquito

7b9d4c1

Merge branch 'master' of https://github.com/ecadlabs/taquito

37e14e4

Merge branch 'master' of https://github.com/ecadlabs/taquito

dc68be9

Merge branch 'master' of https://github.com/ecadlabs/taquito

f259810

Merge branch 'master' of https://github.com/ecadlabs/taquito

6fdda51

Merge branch 'master' of https://github.com/ecadlabs/taquito

298b413

Merge branch 'master' of https://github.com/ecadlabs/taquito

06af53b

Merge branch 'master' of https://github.com/ecadlabs/taquito

e4853cf

Merge branch 'master' of https://github.com/ecadlabs/taquito

fc2e2b0

Merge branch 'master' of https://github.com/ecadlabs/taquito

a64564e

Merge branch 'master' of https://github.com/ecadlabs/taquito

ae561ab

Merge branch 'master' of https://github.com/ecadlabs/taquito

0a2974b

Merge branch 'master' of https://github.com/ecadlabs/taquito

708d150

Merge branch 'master' of https://github.com/ecadlabs/taquito

e018e9e

Merge branch 'master' of https://github.com/ecadlabs/taquito

4523ffb

Merge branch 'master' of https://github.com/ecadlabs/taquito

3c386ad

Merge branch 'master' of https://github.com/ecadlabs/taquito

dffb59c

Merge branch 'master' of https://github.com/ecadlabs/taquito

b58a460

Merge branch 'master' of https://github.com/ecadlabs/taquito

8fa69af

Merge branch 'master' of https://github.com/ecadlabs/taquito

a896a23

Merge branch 'master' of https://github.com/ecadlabs/taquito

fd47258

hui-an-yang added 6 commits April 11, 2024 13:54

Merge branch 'master' of https://github.com/ecadlabs/taquito

00892e8

Merge branch 'master' of https://github.com/ecadlabs/taquito

a39aaa5

Merge branch 'master' of https://github.com/ecadlabs/taquito

82f5a89

Merge branch 'master' of https://github.com/ecadlabs/taquito

bbaba4b

Merge branch 'master' of https://github.com/ecadlabs/taquito into 292…

729c977

…2-michel-codec-doc

docs: adding michel-codec page to website

20e1521

github-actions bot deployed to taquito-test-dapp (Preview) May 24, 2024 06:01 View deployment

hui-an-yang linked an issue May 27, 2024 that may be closed by this pull request

Add Michel-codec package documentation on website #2922

Closed

2 tasks

hui-an-yang requested review from ac10n and dsawali May 27, 2024 17:08

hui-an-yang marked this pull request as ready for review May 27, 2024 17:08

dsawali suggested changes May 27, 2024

View reviewed changes

docs: address review comments

daa592b

github-actions bot deployed to taquito-test-dapp (Preview) May 27, 2024 21:59 View deployment

hui-an-yang requested a review from dsawali May 27, 2024 22:44

dsawali suggested changes May 27, 2024

View reviewed changes

docs: addressed review comments

6010777

github-actions bot deployed to taquito-test-dapp (Preview) May 28, 2024 00:01 View deployment

hui-an-yang requested a review from dsawali May 28, 2024 17:10

hui-an-yang merged commit 19adca7 into master May 28, 2024
9 of 10 checks passed

hui-an-yang deleted the 2922-michel-codec-doc branch May 28, 2024 21:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2922 michel codec doc #2972

2922 michel codec doc #2972

hui-an-yang commented May 24, 2024 •

edited

Loading

github-actions bot commented May 24, 2024 •

edited

Loading

github-actions bot commented May 24, 2024 •

edited

Loading

dsawali May 27, 2024

hui-an-yang May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024 •

edited

Loading

hui-an-yang May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

hui-an-yang May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

hui-an-yang May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

dsawali May 27, 2024

hui-an-yang May 27, 2024

dsawali May 27, 2024

hui-an-yang May 27, 2024

cloudflare-workers-and-pages bot commented May 27, 2024 •

edited

Loading

dsawali left a comment


		## PACK and UNPACK locally

		### packData & packDataBytes - Pack Michelson data

2922 michel codec doc #2972

2922 michel codec doc #2972

Conversation

hui-an-yang commented May 24, 2024 • edited Loading

Release Note Draft Snippet

github-actions bot commented May 24, 2024 • edited Loading

github-actions bot commented May 24, 2024 • edited Loading

Published packages:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dsawali May 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cloudflare-workers-and-pages bot commented May 27, 2024 • edited Loading

Deploying taquito with Cloudflare Pages

dsawali left a comment

Choose a reason for hiding this comment

hui-an-yang commented May 24, 2024 •

edited

Loading

github-actions bot commented May 24, 2024 •

edited

Loading

github-actions bot commented May 24, 2024 •

edited

Loading

dsawali May 27, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented May 27, 2024 •

edited

Loading