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 docstrings for undocumented components #503

Open
spacebear21 opened this issue Jan 21, 2025 · 1 comment
Open

Add docstrings for undocumented components #503

spacebear21 opened this issue Jan 21, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@spacebear21
Copy link
Collaborator

Start on docs.rs/payjoin to see which modules, structs, functions, enum variants... are missing documentation.

Helpful resource: https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html

@spacebear21 spacebear21 added the good first issue Good for newcomers label Jan 21, 2025
@spacebear21 spacebear21 added the documentation Improvements or additions to documentation label Jan 22, 2025
@spacebear21
Copy link
Collaborator Author

spacebear21 commented Feb 13, 2025

Something I noticed is that receive::v2 docstrings are lacking compared to receive::v1. This is unfortunate because we want to encourage v2 usage, but currently users are left in the dark (despite relevant docs existing in the inner components, but not reflected on the wrapper). Example: https://docs.rs/payjoin/latest/payjoin/receive/v2/struct.ProvisionalProposal.html#implementations

Most structs and methods are the same so the docstrings should really be mirrored between v1 and v2 components. It would be cool if there was a way to forward dosctrings declarations from the inner to the wrapper, but AFAIK that's not possible so we'll need to duplicate those entries.

@thebrandonlucas thebrandonlucas self-assigned this Mar 5, 2025
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
Status: No status
Development

No branches or pull requests

2 participants