Skip to content

Hide implementation details of amaranth.hdl #781

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.

Sign up for GitHub

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

Jump to bottom
Closed
4 of 5 tasks
whitequark opened this issue May 13, 2023 · 2 comments · Fixed by #1062 or #1390
Closed
4 of 5 tasks

Hide implementation details of amaranth.hdl #781

whitequark opened this issue May 13, 2023 · 2 comments · Fixed by #1062 or #1390
Labels
improvement
Milestone
0.6

Comments

@whitequark
Copy link
Member

whitequark commented May 13, 2023 •
edited
Loading

I propose:

  • documenting the complete set of names under amaranth.hdl that are provided for use by Amaranth programmers Document the Python APIs in amaranth.hdl #785
  • making all of the existing modules under amaranth.hdl private (starting with _);
  • adding a compatibility shim for accesses through the currently public modules;
  • deprecating such accesses;
  • removing the shim in version 0.6
@whitequark whitequark added this to the 0.4 milestone May 13, 2023
@whitequark
Copy link
Member Author

We've discussed this RFC on the 2023-05-15 weekly meeting. The disposition was to merge the PR implementing the proposed changes.

@whitequark whitequark mentioned this issue May 15, 2023
Open
1 task
@jalcim jalcim mentioned this issue Aug 6, 2023
Closed
@whitequark whitequark modified the milestones: 0.4, 0.5 Aug 17, 2023
whitequark added a commit to whitequark/amaranth that referenced this issue Jan 30, 2024
@whitequark
amaranth.hdl: start all private names with an underscore.
c40a8f5 
This change follows the reference documentation effort.

Fixes amaranth-lang#781.
@whitequark whitequark mentioned this issue Jan 30, 2024
Merged
whitequark added a commit to whitequark/amaranth that referenced this issue Jan 30, 2024
@whitequark
amaranth.hdl: start all private names with an underscore.
ee58c5a 
This change completes commit 9dc0617 and makes all the tests pass.
It corresponds with the ongoing langauge reference documentation effort.

Fixes amaranth-lang#781.
github-merge-queue bot pushed a commit that referenced this issue Jan 30, 2024
@whitequark
amaranth.hdl: start all private names with an underscore.
5dd1223 
This change completes commit 9dc0617 and makes all the tests pass.
It corresponds with the ongoing langauge reference documentation effort.

Fixes #781.
@whitequark whitequark reopened this Jan 30, 2024
@whitequark whitequark modified the milestones: 0.5, 0.6 Jan 30, 2024
@whitequark
Copy link
Member Author

Reopening and moving to 0.6 since that's when the compatibility shims will be removed.

wanda-phi added a commit to wanda-phi/amaranth that referenced this issue Jun 14, 2024
@wanda-phi
hdl: hide implementation details.
aa11087 
Fixes amaranth-lang#781.
@wanda-phi wanda-phi mentioned this issue Jun 14, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Jun 14, 2024
@wanda-phi @whitequark
hdl: hide implementation details.
4e28140 
Fixes #781.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
improvement
Milestone
0.6
1 participant
@whitequark