search

ergoplatform / ergo-lib-wasm

ergo-lib bindings for JS/TS
Creative Commons Zero v1.0 Universal
4 stars 3 forks source link

Update docstring links to use `tsdoc` link convention #6

Open ross-weir opened 1 year ago

ross-weir commented 1 year ago

Update rust links in docstrings to use tsdoc linking & camel cased names, i.e:

/// You can verify it against a Blakeb256 root hash by using [`Self::valid()`]

changed to

/// You can verify it against a Blakeb256 root hash by using {@link MerkleProof.isValid}

So links generated in TS/JS documentation work.

More info: https://tsdoc.org/pages/tags/link/

maddy020 commented 1 year ago

I want to work on this issue Please assign it to me

maddy020 commented 1 year ago

Hey @ross-weir I want to work on this issue In which file I need to change I am unable to find the page

ross-weir commented 1 year ago

Hey @ross-weir I want to work on this issue In which file I need to change I am unable to find the page

Great! Thank you!

This file is the only one currently that needs updating: https://github.com/ergoplatform/ergo-lib-wasm/blob/main/packages/merkle-tree/src/lib.rs

This line, for example: https://github.com/ergoplatform/ergo-lib-wasm/blob/main/packages/merkle-tree/src/lib.rs#L76

ross-weir commented 1 year ago

I'll keep this open as a WIP, there'll be more to fix up as we migrate