Finish lib.memory documentation
#1228
Merged
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 #1228 +/- ##
==========================================
+ Coverage 89.65% 89.78% +0.12%
==========================================
Files 43 43
Lines 9718 9923 +205
Branches 2331 2395 +64
==========================================
+ Hits 8713 8909 +196
- Misses 816 822 +6
- Partials 189 192 +3 ☔ View full report in Codecov by Sentry. |
whitequark
force-pushed
the
memory-docs
branch
2 times, most recently
from
6bc588a to
25ef347
Compare
This attribute is fully redundant with `.__len__()`, and is out of place on a `list`-like container like `Memory.Init`. The `.shape` attribute, however, provides a unique function.
Display `shape` and `depth` also. `depth` is redundant although useful for ease of reading (there are always `depth` elements shown), but `shape` was just lost.
The abbreviated form was initially added to match `lib.fifo`, but it looks very out of place on `lib.memory`, and we may be moving away from such heavy use of abbreviations anyway. While technically a breaking change, these attributes have very narrow usefulness and so this change qualifies as "minor".
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.
This PR carries two "minor" semantic changes as well:
Memory.Init.depth.Memory.{r,w}_portsto.{read,write}_ports.See the commit messages for details.