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

Update docstring links to use tsdoc link convention #6

Open
ross-weir opened this issue Dec 25, 2022 · 4 comments
Open

Update docstring links to use tsdoc link convention #6

ross-weir opened this issue Dec 25, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@ross-weir
Copy link
Collaborator

ross-weir commented Dec 25, 2022

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/

@ross-weir ross-weir added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 25, 2022
@maddy020
Copy link
Contributor

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

@maddy020
Copy link
Contributor

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
Copy link
Collaborator Author

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
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants