docs: clarify realize_environment only runs on new descriptors #712

Open

SakulFlee wants to merge 1 commit from perf/environment-realize-once into main

SakulFlee commented

2026-07-17 22:05:02 +02:00

Owner

The comment incorrectly suggested the environment was re-realized every
frame. In reality, the descriptor is cleared to None on success, so
the function only runs when a new environment descriptor is provided.
Updated the comment to reflect the actual behavior.

The comment incorrectly suggested the environment was re-realized every frame. In reality, the descriptor is cleared to None on success, so the function only runs when a new environment descriptor is provided. Updated the comment to reflect the actual behavior.

SakulFlee self-assigned this

2026-07-17 22:05:02 +02:00

SakulFlee added 1 commit

2026-07-17 22:05:02 +02:00

docs: clarify realize_environment only runs on new descriptors

ci/woodpecker/push/linting Pipeline was successful

Details

c524a4af7d

The comment incorrectly suggested the environment was re-realized every
frame. In reality, the descriptor is cleared to None on success, so
the function only runs when a new environment descriptor is provided.
Updated the comment to reflect the actual behavior.

ci/woodpecker/push/linting Pipeline was successful

Details

ci/woodpecker/pr/test

Required

ci/woodpecker/pr/linting

Required

This pull request has changes conflicting with the target branch.

Crates/orbital_app/src/systems/realize.rs

View command line instructions

Manual merge helper

Use this merge commit message when completing the merge manually.

Merge commit title

Merge pull request 'docs: clarify realize_environment only runs on new descriptors' (#712) from perf/environment-realize-once into main

Merge commit body

Reviewed-on: https://forgejo.sakul-flee.de/SakulFlee/Orbital/pulls/712

Merge pull request 'docs: clarify realize_environment only runs on new descriptors' (#712) from perf/environment-realize-once into main

Reviewed-on: https://forgejo.sakul-flee.de/SakulFlee/Orbital/pulls/712

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin perf/environment-realize-once:perf/environment-realize-once

git switch perf/environment-realize-once

No reviewers

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

SakulFlee/Orbital!712

No description provided.

Rows
Columns