We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
tsdoc
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/
The text was updated successfully, but these errors were encountered:
I want to work on this issue Please assign it to me
Sorry, something went wrong.
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
I'll keep this open as a WIP, there'll be more to fix up as we migrate
No branches or pull requests
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/
The text was updated successfully, but these errors were encountered: