amaranth icon indicating copy to clipboard operation
amaranth copied to clipboard

Implement RFC 30: Component metadata.

Open jfng opened this issue 1 year ago • 7 comments

jfng avatar Dec 01 '23 16:12 jfng

Rebased to current main branch.

jfng avatar Jan 15 '24 16:01 jfng

Codecov Report

Attention: Patch coverage is 96.15385% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 90.93%. Comparing base (dde8334) to head (861a412). Report is 14 commits behind head on main.

:exclamation: Current head 861a412 differs from pull request most recent head 519f35a. Consider uploading reports for the commit 519f35a to get more accurate results

Files Patch % Lines
amaranth/lib/meta.py 92.00% 2 Missing :warning:
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #978      +/-   ##
==========================================
+ Coverage   90.48%   90.93%   +0.44%     
==========================================
  Files          43       45       +2     
  Lines       10864    10640     -224     
  Branches     2660     2596      -64     
==========================================
- Hits         9830     9675     -155     
+ Misses        855      777      -78     
- Partials      179      188       +9     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jan 15 '24 16:01 codecov[bot]

Update to track changes to the RFC.

jfng avatar Jan 16 '24 12:01 jfng

Rebased on current main.

Updated Signature.annotations(self, obj) to Signature.annotations(self, obj, /); This prevents obj from being set as a kwarg, which allows subclasses to rename it (e.g. to interface).

jfng avatar Jan 19 '24 10:01 jfng

Looks good to me. The lib.meta module still needs reference documentation, and lib.wiring module's reference documentation needs to be expanded, before the feature is considered fully done.

Agreed.

jfng avatar Jan 19 '24 10:01 jfng

I've added a task list to the tracking issue: https://github.com/amaranth-lang/amaranth/issues/1047#issue-2094460017

whitequark avatar Jan 22 '24 23:01 whitequark

Updated with documentation and changelog entry.

The CI link check will fail until the ComponentMetadata schema is published to https://amaranth-lang.org/schema/amaranth/0.5/component.json.

jfng avatar Apr 30 '24 11:04 jfng