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

Fix typo mantisa -> mantissa #1499

Closed
wants to merge 1 commit into from

Conversation

fabiensanglard
Copy link

The correct spelling is "mantisSa"

@fabiensanglard
Copy link
Author

This is a change in the API but these structure were merged recently and have not been published in a stable release. I think it is fine to fix the typo.

@fabiensanglard
Copy link
Author

@mcuee and @tormodvolden please take a look

@mcuee mcuee added core Related to common codes API API changes labels May 22, 2024
@mcuee
Copy link
Member

mcuee commented May 22, 2024

This is a change in the API but these structure were merged recently and have not been published in a stable release. I think it is fine to fix the typo.

I agree with you. But I will let @tormodvolden decide.

@mcuee mcuee added the Misc Whitespace, typo, coding style, etc label May 22, 2024
Copy link
Member

@Youw Youw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.
This hasn't been released yet and just recently added. Better to fix now, while it doesn't impact too many users (if any).

@tormodvolden
Copy link
Contributor

Yes, there is no problem fixing up the API before it has been published. Thanks for taking a double look!

We did a less than stellar job at reviewing this. The spelling was not even consistent with the code comments. Curiously, codespell wouldn't have caught "mantisa" even in a comment. It does find these though, introduced in the same commit:

$ codespell libusb
libusb/descriptor.c:1008: ony ==> only, on, one
libusb/descriptor.c:1028: re-use ==> reuse

Further, maybe we should spell superspeed+/SuperSpeed+/SuperSpeedPlus consistently, also for better searchability?

Apart from certain platform files in os/* we use classic style /* */ for comments and not the C++ style // up to now almost consistently, so it we shouldn't diverge here.

Can you please fix up these as well? In the meantime I'll merge the present API change, it is worth having it separately from cosmetic changes in any case.

@fabiensanglard
Copy link
Author

@tormodvolden: All done in PR #1502 1502

tormodvolden pushed a commit that referenced this pull request May 26, 2024
- Fix typos.
- Use SuperSpeedPlus naming consistently.
- Remove C++ style comment in favor of C style.

Fixup of commit f00f06e

References #1499
Closes #1502
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API API changes core Related to common codes Misc Whitespace, typo, coding style, etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants