boa-dev / temporal

A Rust implementation of ECMAScript's Temporal API
Apache License 2.0
26 stars 4 forks source link

Add more documentation and doctests to the builtins #107

Open nekevss opened 2 weeks ago

nekevss commented 2 weeks ago

Currently, the project has been relatively relaxed as far as documentation and doctests, but these are also incredibly useful for any users looking to use temporal_rs. Furthermore, it allows us to really get a better feel for the API while also providing more tests.

My initial thought is that we should try to have doctests for the builtins below and their main methods that may have high user visibility: