Repository navigation
docs: document is_configured_realtime for graph construction - #788
Closed
pengpengyi92 wants to merge 1 commit into
Closed
pengpengyi92 wants to merge 1 commit into
pengpengyi92 wants to merge 1 commit into
Conversation
Signed-off-by: Pengyi Peng <74917296+pengpengyi92@users.noreply.github.com>
Member
|
Thanks for the PR! I've consolidated some docs updates in #795 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #395.
Document
csp.is_configured_realtime()in the Graph Utilities API reference:csp.in_realtime()builtin, including historical replay in a realtime-configured run;Scope: one documentation file. No runtime, adapter, dependency, or API behavior changes. This does not modify Execution Modes or duplicate the replay examples in #740 / #761.
Validation
python -m pytest csp/tests/impl/wiring csp/tests/test_engine.py::TestEngine::test_realtime_flag -q-> 22 passed, 2 skipped, before and after the documentation change.python -m mdformat --check docs/wiki/api-references/Graph-Utilities-API.md-> passed.python -m codespell_lib docs/wiki/api-references/Graph-Utilities-API.md-> passed.git diff --check-> passed.Environment: Windows, Python 3.12.14, local CSP Python source with official CSP 0.19.1 Windows wheel native libraries. No C++ rebuild or Linux/macOS matrix was run. The extra helper-contract checks are local verification, not added upstream tests. Upstream CI and maintainer review are not implied by these results.
Draft for maintainer review of scope and wording; no engine behavior change is proposed.