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

Add some testing / debugging docs #176

Merged
merged 5 commits into from
Jan 23, 2025
Merged

Add some testing / debugging docs #176

merged 5 commits into from
Jan 23, 2025

Conversation

nekevss
Copy link
Member

@nekevss nekevss commented Jan 22, 2025

Per the title, this PR adds to the testing / debugging docs.

More specifically, this PR adds a general overview on the ways that temporal_rs is tested along with some pointers on testing and debugging using Boa.

@nekevss nekevss added the C-internal Internal library improvements label Jan 22, 2025
@nekevss nekevss force-pushed the contrib-docs-update branch from 95d46fd to 96038b6 Compare January 22, 2025 06:00
Copy link
Member

@jedel1043 jedel1043 left a comment

Choose a reason for hiding this comment

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

Nice documentation! I have a couple of fixes and suggestions on some wordings.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated
If you're interested in helping out but don't see an issue that's for you, please feel free to contact
us on the `Boa` discord.
If you're interested in helping out but don't see an issue that's for
you, please feel free to contact us on the `Boa` discord.
Copy link
Member

Choose a reason for hiding this comment

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

Let's redirect to our Matrix server instead.

docs/testing.md Outdated

#### Specify method test suites

The test suite can be further specified by further qualifying the path.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The test suite can be further specified by further qualifying the path.
The test suite can be further specified by qualifying the path.

docs/testing.md Outdated
#### Debugging single `test262` tests

When debugging a specific test, the test output can be viewed by running
the test with the following flags.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
the test with the following flags.
the test in verbose mode (`-vvv`):

docs/testing.md Outdated
Comment on lines 51 to 52
Running the above command will output whether the test was failed or
passed, and the test failure output if failed.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Running the above command will output whether the test was failed or
passed, and the test failure output if failed.
Running the above command will output whether the test failed or
passed, and the test failure output if failed.

docs/testing.md Outdated
Comment on lines 58 to 60
`/home/nekevss/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: starting
`/home/nekevss/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: Failed
`/home/nekevss/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: result text
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`/home/nekevss/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: starting
`/home/nekevss/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: Failed
`/home/nekevss/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: result text
`/home/user/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: starting
`/home/user/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: Failed
`/home/user/Projects/boa/test262/test/built-ins/Temporal/Instant/compare/argument-string-limits.js`: result text

nekevss and others added 3 commits January 22, 2025 23:07
Co-authored-by: José Julián Espina <[email protected]>
Co-authored-by: José Julián Espina <[email protected]>
@nekevss nekevss requested a review from jedel1043 January 23, 2025 05:13
@nekevss nekevss merged commit 186d26a into main Jan 23, 2025
6 checks passed
@nekevss nekevss deleted the contrib-docs-update branch January 23, 2025 05:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-internal Internal library improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants