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.

Sign up for GitHub

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

Jump to bottom

Code doc for published library #107

Open
Tracked by #30
slhmy opened this issue Jun 19, 2023 · 2 comments
Open
Tracked by #30

Code doc for published library #107

slhmy opened this issue Jun 19, 2023 · 2 comments
Labels
medium priority Should be fixed after high priority issues

Comments

@slhmy
Copy link
Member

slhmy commented Jun 19, 2023

No description provided.

@slhmy slhmy added the medium priority Should be fixed after high priority issues label Jun 19, 2023
@slhmy slhmy mentioned this issue Jun 19, 2023
Open
5 tasks
@akamya997
Copy link
Contributor

Could you give more detail/samples for doc writing?

@slhmy
Copy link
Member Author

slhmy commented Jun 29, 2023

Could you give more detail/samples for doc writing?

Search for cargo doc written will help，for I can't make an example so fast.

Or a more simple approach is
using /// comment on above of your function and structs, and write with markdown syntax 🤨 just example what's happening inside or what design we have considered.

@slhmy slhmy mentioned this issue Dec 10, 2023
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
medium priority Should be fixed after high priority issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@slhmy @akamya997