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 & format documentation #252

Merged
merged 17 commits into from
Mar 7, 2024
Merged

Update & format documentation #252

merged 17 commits into from
Mar 7, 2024

Conversation

NyxCode
Copy link
Collaborator

@NyxCode NyxCode commented Mar 6, 2024

No description provided.

@NyxCode
Copy link
Collaborator Author

NyxCode commented Mar 6, 2024

Arghh. Docs look much nicer on using cargo docs, but now the README looks awefull.

@escritorio-gustavo
Copy link
Contributor

We have some methods that are provided but their default implementation just panics. Should we remove the default impl to show that these methods are required in case someone decides to manually implement TS?

@NyxCode
Copy link
Collaborator Author

NyxCode commented Mar 7, 2024

Thanks for cleaning everything up! <3

Should we remove the default impl to show that these methods are required in case someone decides to manually implement TS?

Sure, I like that idea! Can we already merge this, since you opened a separate PR for that?

@NyxCode NyxCode marked this pull request as ready for review March 7, 2024 14:25
@NyxCode
Copy link
Collaborator Author

NyxCode commented Mar 7, 2024

Hm, actually, I think I'll add a few docs to typelist, that's entirely undocumented right now, and it is part of the public interface.

@escritorio-gustavo
Copy link
Contributor

Can we already merge this, since you opened a separate PR for that?

Sure! It's all good from my side

@NyxCode NyxCode merged commit 7fc4945 into main Mar 7, 2024
10 checks passed
@escritorio-gustavo escritorio-gustavo deleted the update-docs branch March 7, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants