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 rustdoc comments on various API-related fields. #2846

Closed
dessalines opened this issue May 9, 2023 · 0 comments
Closed

Add rustdoc comments on various API-related fields. #2846

dessalines opened this issue May 9, 2023 · 0 comments
Assignees
Labels
area: docs Documentation fixes

Comments

@dessalines
Copy link
Member

Some of the API request and result types shown in lemmy-js-client, have some comments. example

But now that we are auto-generating the typescript types using ts-rs, these comments will be wiped out. This is an issue for me to copy over the existing ones to rustdoc, as well as add any that seem necessary.

Unfortunately, ts-rs doesn't support rustdoc -> typedoc yet, but likely will in the future:

Aleph-Alpha/ts-rs#52

These comments will benefit both people who use the Rust API types, and eventually, the typescript types.

@dessalines dessalines added the area: docs Documentation fixes label May 9, 2023
@dessalines dessalines self-assigned this May 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Documentation fixes
Projects
None yet
Development

No branches or pull requests

1 participant