Skip to content

Expand documentation, examples, and performance tests#3

Open
Waiting-Chai wants to merge 1 commit intomainfrom
codex/-simpy-l3jmog
Open

Expand documentation, examples, and performance tests#3
Waiting-Chai wants to merge 1 commit intomainfrom
codex/-simpy-l3jmog

Conversation

@Waiting-Chai
Copy link
Copy Markdown
Owner

Summary

  • rewrite the README with detailed overview, features, performance notes, and example navigation
  • add runnable examples showcasing environment basics, priority resource usage, and condition composition
  • add performance-focused JUnit tests covering timeout bursts and dense callback chains

Testing

  • mvn -pl sim test (fails: Maven Central returns HTTP 403 when downloading dependencies)

Codex Task

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +33 to +36
Timeout frame = env.timeout(4, "frame");
Timeout electronics = env.timeout(2, "electronics");
AllOf finished = env.allOf(frame, electronics);
yield finished;
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Replace generator-style yield with ProcessContext awaits

The example process is written with Python-like yield finished;, but Process.ProcessFunction expects you to block on events via the provided ProcessContext (e.g., ctx.await(...)). Using yield here is neither valid Java syntax nor a call to await an event, so the example will not compile or run; the same issue applies to the later yield env.timeout(10); in this class.

Useful? React with 👍 / 👎.

Comment on lines +28 to +32
PriorityRequest request = cashier.request(priority);
yield request;

System.out.printf("t=%.0f -> %s got service\n", env.now(), name);
yield env.timeout(serviceTime);
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Example process uses invalid yield instead of ctx.await

This example uses bare yield statements (yield request;, yield env.timeout(serviceTime);) inside a ProcessFunction, but the process API requires awaiting events through the provided context (e.g., ctx.await(...)). As written the code is invalid Java and won’t compile/run, undermining the “runnable example” intent.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant