Document the simulator #1374
Merged
Document the simulator #1374
+1,680
−732
Conversation
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1374 +/- ##
==========================================
+ Coverage 90.99% 91.09% +0.09%
==========================================
Files 45 45
Lines 11218 11302 +84
Branches 2429 2763 +334
==========================================
+ Hits 10208 10295 +87
+ Misses 831 830 -1
+ Partials 179 177 -2 ☔ View full report in Codecov by Sentry. |
whitequark
force-pushed
the
document-simulator
branch
from
10f7a35 to
45ed83e
Compare
whitequark
force-pushed
the
document-simulator
branch
from
3f6265f to
52b12a6
Compare
This causes one test to fail due to a now-exposed bug. Co-authored-by: Wanda <[email protected]>
whitequark
force-pushed
the
document-simulator
branch
from
57743d9 to
bf905ad
Compare
This commit includes additional non-documentation changes, related to issues found while documenting it: - `Simulator.run_until()` no longer accepts a `run_passive=` argument. Passive no longer exist and in any case defaulting to `False` does not make a lot of sense from an API perspective. - `add_clock()`'s `phase=` argument, when specified, no longer has `period/2` added to it. This wasn't the documented behavior in first place and it makes no sense to do that. - `add_clock()` raises a `NameError` if a clock domain does not exist, instead of `ValueError`. - `add_clock()` raises a `DriverConflict` if a clock domain is already being driven by a clock, instead of `ValueError`. - GTKWave is no longer a part of the installation instructions, and both Surfer and GTKWave are recommended (in this order).
whitequark
force-pushed
the
document-simulator
branch
from
bf905ad to
baf3b73
Compare
Merged
via the queue into
amaranth-lang:main
with commit Jun 10, 2024
7870eb3
17 of 20 checks passed
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.
Rendered