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

Documentation for CRC util #2963

Closed
michael-etzkorn opened this issue Apr 14, 2022 · 0 comments
Closed

Documentation for CRC util #2963

michael-etzkorn opened this issue Apr 14, 2022 · 0 comments

Comments

@michael-etzkorn
Copy link
Contributor

michael-etzkorn commented Apr 14, 2022

Type of issue: other enhancement

Impact: enhanced user experience

Development Phase: proposal

Other information

What is the current behavior?
User is directed to CRC zoo where implicit 1 notation is used but CRC object uses explicit 1 notation which can cause unexpected behavior if require is not hit.
What is the expected behavior?

Document that this is explicit 1 notation and that crc zoo uses implicit 1 notation.

What is the use case for changing the behavior?
This was only discoverable while reading the code and noticing the require. This'll prevent user misuse and headache.

https://github.com/chipsalliance/rocket-chip/blob/master/src/main/scala/util/CRC.scala#L14

@michael-etzkorn michael-etzkorn changed the title CRC Documentation Documentation for CRC util Apr 14, 2022
michael-etzkorn added a commit that referenced this issue Apr 14, 2022
#2963 just so users can follow the CRC object's API a bit better. 


Perhaps #2960 should include a scala doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants