Skip to content

Start all private names in amaranth.hdl with an underscore #1062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 30, 2024

Conversation

whitequark
Copy link
Member

This change tracks the reference documentation effort started in #1058.

Fixes #781.

Copy link

codecov bot commented Jan 30, 2024

Codecov Report

Attention: 163 lines in your changes are missing coverage. Please review.

Comparison is base (e88ff13) 86.54% compared to head (c40a8f5) 86.54%.

❗ Current head c40a8f5 differs from pull request most recent head ee58c5a. Consider uploading reports for the commit ee58c5a to get more accurate results

Files Patch % Lines
amaranth/hdl/_ast.py 90.35% 73 Missing and 27 partials ⚠️
amaranth/hdl/_xfrm.py 95.35% 12 Missing and 11 partials ⚠️
amaranth/hdl/_ir.py 96.20% 8 Missing and 8 partials ⚠️
amaranth/back/rtlil.py 66.66% 10 Missing and 4 partials ⚠️
amaranth/hdl/_mem.py 95.55% 3 Missing and 3 partials ⚠️
amaranth/back/verilog.py 25.00% 3 Missing ⚠️
amaranth/hdl/_dsl.py 99.74% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1062      +/-   ##
==========================================
- Coverage   86.54%   86.54%   -0.01%     
==========================================
  Files          41       41              
  Lines        7159     7157       -2     
  Branches     1712     1711       -1     
==========================================
- Hits         6196     6194       -2     
  Misses        797      797              
  Partials      166      166              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This change completely breaks the library. It is done separately just
to make sure git tracks renames as such.
This change completes commit 9dc0617 and makes all the tests pass.
It corresponds with the ongoing langauge reference documentation effort.

Fixes amaranth-lang#781.
@whitequark whitequark force-pushed the hide-amaranth.hdl-innards branch from c40a8f5 to ee58c5a Compare January 30, 2024 16:57
@whitequark whitequark added this pull request to the merge queue Jan 30, 2024
@whitequark whitequark added this to the 0.5 milestone Jan 30, 2024
Merged via the queue into amaranth-lang:main with commit 5dd1223 Jan 30, 2024
@whitequark whitequark deleted the hide-amaranth.hdl-innards branch January 30, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Hide implementation details of amaranth.hdl
1 participant