Skip to content
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

Explicit deprecation/removal notice for FHDLTestCase #484

Closed
BracketMaster opened this issue Aug 22, 2020 · 3 comments
Closed

Explicit deprecation/removal notice for FHDLTestCase #484

BracketMaster opened this issue Aug 22, 2020 · 3 comments
Milestone

Comments

@BracketMaster
Copy link

BracketMaster commented Aug 22, 2020

FHDLTestCase is no longer accessible in nMigen 0.3.
An attempt to import it should still fail, but let the user
know FHDLTestCase was intentionally removed.

Perhaps something to the effect of

Removal Notice: FHDLTestCase has been removed as per https://github.com/nmigen/nmigen/pull/399#issuecomment-638514027

Maybe Removal Notice could be highlighted in red?

@whitequark whitequark added this to the 0.3 milestone Aug 22, 2020
@whitequark whitequark changed the title Deprecation Warnings and Removal Notices Explicit deprecation/removal notice for FHDLTestCase Aug 22, 2020
@whitequark
Copy link
Member

whitequark commented Aug 22, 2020

Given how many people turned out to (rather unexpectedly, for me at least) depend on it, I'm open to going through a full deprecation cycle for FHDLTestCase (i.e. it would be accessible in 0.3 with a warning, and removed in 0.4).

@awygle
Copy link
Collaborator

awygle commented Aug 23, 2020

I think this is a good idea, and I also think it highlights that (given you clearly don't like FHDLTestCase, whitequark) we should prioritize designing its replacement (if any? not sure what your long-term plans are here). I know I'm using (a local fork of) FHDLTestCase in all of my nmigen designs, and most people I talk to are excited to use formal tooling with nmigen. This issue isn't the right place to track that of course so we should file a separate one if we don't have it already...

@whitequark
Copy link
Member

whitequark commented Aug 24, 2020

given you clearly don't like FHDLTestCase,

It's not that I don't like it in particular. It's more that it was always intended as an internal API, and absolutely no thought went into its design. I assumed, wrongly, that people would know better than to dig out random stuff from the test/ subfolder...

we should prioritize designing its replacement

Sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants