rtllib documentation cleanup#491
Open
fdxmw wants to merge 4 commits into
Open
Conversation
* Add AES doctest examples. * Make AES method names more consistent. Forward calls to the deprecated old method names to the new method names. * Convert PRNG examples to doctest examples. Also: * Update PRNGs to use State Registers. * Include `render_trace` output directly in examples. * `render_trace`: Remove trailing whitespace from output. * Always use the `pyrtl.` package prefix in examples. * Add more documentation links to specific `examples/`. * Stop publishing documentation for: * half_adder, one_bit_add, ripple_add, ripple_half_add (undocumented) * testingutils (nondeterministic tests are generally a bad idea)
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## development #491 +/- ##
=============================================
+ Coverage 92.2% 92.2% +0.1%
=============================================
Files 30 30
Lines 7441 7450 +9
=============================================
+ Hits 6855 6865 +10
+ Misses 586 585 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…, and add a comment. The example shouldn't be doctested because it depends on Yosys, which may not be installed.
…r `pip install` examples.
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
1 participant
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.
Also:
render_traceoutput directly in examples.render_trace: Remove trailing whitespace from output.pyrtl.package prefix in examples.examples/.