Skip to content

Fix README grammar and whitespace #58

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 28, 2025
Merged

Fix README grammar and whitespace #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ however you probably want to use it in combination with CodeTracer, which would

### ENV variables

* if you pass `CODETRACER_RUBY_RECORDER_DEBUG=1`, you enables some additional debug-related logging
* if you pass `CODETRACER_RUBY_RECORDER_DEBUG=1`, you enable some additional debug-related logging
* `CODETRACER_RUBY_RECORDER_OUT_DIR` can be used to specify the directory for trace files

## Future directions
Expand All @@ -64,7 +64,7 @@ The current Ruby support is a prototype. In the future, it may be expanded to fu
### Current approach: TracePoint API

Currently we're using the TracePoint API: https://rubyapi.org/3.4/o/tracepoint .
This is very flexible and can function with probably multiple Ruby versions out of the box.
This is very flexible and can function with probably multiple Ruby versions out of the box.
However, this is limited:

* it's not optimal
Expand All @@ -86,7 +86,7 @@ The patching can be done either directly in the source code of the VM or through

#### Filtering

It would be useful to have a way to record only certain intervals within the program execution, or certain functions or modules:
It would be useful to have a way to record only certain intervals within the program execution, or certain functions or modules:
we plan on expanding the [trace format](https://github.com/metacraft-labs/runtime_tracing/) and CodeTracer' support, so that this is possible. It would let one be able to record interesting
parts of even long-running or more heavy programs.

Expand Down
Loading