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

📚 Readme update #140

Closed
2 tasks
Ramya-Ab opened this issue Jan 29, 2024 · 2 comments · Fixed by #141
Closed
2 tasks

📚 Readme update #140

Ramya-Ab opened this issue Jan 29, 2024 · 2 comments · Fixed by #141

Comments

@Ramya-Ab
Copy link
Contributor

Ramya-Ab commented Jan 29, 2024

Summary

The "Available CRC Configurations" section of the readme is to be updated, with respect to the attribute "SAJ1850"

Details

Under the "Available CRC Configurations" section of the readme:

  1. Under CRC8, there is an attribute named "SAJ1850". However, using this attribute for CRC calculation causes an AttributeError: SAJ1850. Using the attribute "SAEJ1850" works, however. So the documentation can be updated to mention "SAEJ1850" instead of "SAJ1850".

  2. The section also states "For convince various frequently used crc configurations ship with the library out of the box." - is it meant to state "For convenience" instead? If yes, this typo can be corrected.

Background & Context

Why should this documentation be added/updated?
Using the attribute "SAJ1850" instead of "SAEJ1850" for CRC calculation causes an AttributeError: SAJ1850.
Possible typo in the documentation: "For convince various frequently used crc configurations ship with the library out of the box." - is it meant to state "For convenience" instead?

References

https://nicoretti.github.io/crc

Task(s)

  • Update readme: Change "SAJ1850" to "SAEJ1850"
  • Update readme: Correct possible typo of "convince" to "convenience"

Thanks!

@Ramya-Ab
Copy link
Contributor Author

I've created a pull request #141 for this - please check. Thanks!

@Nicoretti
Copy link
Owner

Hi @Ramya-Ab,

thanks for reporting the issue and providing a fix 👍.

best
Nico

@Nicoretti Nicoretti linked a pull request Jan 31, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants