Add rustdoc comments to all public APIs #5870
Labels
C-docs
Category - Documentation. Related to user-facing or internal documentation
good first issue
Experience Level - Good for newcomers
Good documentation is a critical part of promoting adoption from other projects. If users cannot understand how to use our tools, odds are they wont. We should document as much of our public API as possible. At the very least, all mostly-stable APIs should have examples and descriptions on how to use them.
We have a lot of great examples, but many options and return structures are missing descriptions. Plenty of business logic is also missing descriptions.
Crates
These are, in my opinion, the crates that are most important to document right now
oxc_diagnostics
#5865Basically, if it's used anywhere from reading a file -> parsing -> transforming -> printing, then it is a high-priority candidate.
The text was updated successfully, but these errors were encountered: