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

Docstring review #41

Open
danwallach opened this issue Jul 23, 2022 · 0 comments
Open

Docstring review #41

danwallach opened this issue Jul 23, 2022 · 0 comments

Comments

@danwallach
Copy link
Owner

Not anything specific, but we need to work through every single docstring and make sure they're consistent with the code behavior. In particular:

  • In any possible case where an error might be thrown, this needs to be described in detail.
  • Any time we're naming another class, method, or field, we should use the @link notation so we get working hyperlinks.
  • For the most part, the API we're providing deals with serialization and deserialization, but we might have a separate SERIALIZATION.md file that explains how we're using io-ts, how it works, and how to deal with its error handling.
  • When all the docstrings are converted to HTML, I think we get README.md as well, but we need to make sure other Markdown files we might write also get converted.
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

No branches or pull requests

1 participant