Skip to content

Add documentation and doctests for builtins#360

Merged
nekevss merged 10 commits into
boa-dev:mainfrom
blarfoon:builtins-docs
Jun 25, 2025
Merged

Add documentation and doctests for builtins#360
nekevss merged 10 commits into
boa-dev:mainfrom
blarfoon:builtins-docs

Conversation

@blarfoon

@blarfoon blarfoon commented Jun 21, 2025

Copy link
Copy Markdown
Contributor

Added documentation and doctests for builtin types, including MDN references and examples on how to use them with popular use cases.

#107

@nekevss nekevss added the C-documentation Improvements or additions to documentation label Jun 21, 2025

@nekevss nekevss left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, this looks fantastic! Thanks for working on this!

I have a few nitpicks / suggestions that I've filled out below. The big points that I would highlight is: try to use core over std wherever possible in examples, and try to prefer RFC9557(IXDTF) / ISO8601 grammar wherever possible when mentioning date time in a string.

Comment thread src/builtins/core/date.rs Outdated
Comment thread src/builtins/core/date.rs Outdated
Comment thread src/builtins/core/date.rs
Comment thread src/builtins/core/date.rs Outdated
Comment thread src/builtins/core/date.rs Outdated
Comment thread src/builtins/core/datetime.rs Outdated
Comment thread src/builtins/core/duration.rs Outdated
Comment thread src/builtins/core/duration.rs Outdated
Comment thread src/builtins/core/instant.rs Outdated
Comment thread src/builtins/core/instant.rs
@blarfoon blarfoon changed the title Add documentation and doctests for builtins Add documentation and doctests for builtins (https://github.com/boa-dev/temporal/issues/107) Jun 24, 2025
@blarfoon blarfoon changed the title Add documentation and doctests for builtins (https://github.com/boa-dev/temporal/issues/107) Add documentation and doctests for builtins Jun 24, 2025
@blarfoon blarfoon requested a review from nekevss June 24, 2025 23:31
@nekevss

nekevss commented Jun 24, 2025

Copy link
Copy Markdown
Member

I think this may need a rebase to handle the conflict.

After an initial glance, this is looking good.

@nekevss nekevss left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for working on this 😄

@nekevss nekevss merged commit 3eee9a8 into boa-dev:main Jun 25, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants