Mark pywavemap as a typed extension and address cpplint v2.0 warnings #82
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a
py.typed
marker file to indicate that the pywavemap package comes with type annotations. It also addresses warnings about missing includes for STL header files generated by the new version of cpplint.Many thanks to @Divelix for implementing it!
Type of change
Detailed summary
Indicating that pywavemap comes with type annotations is useful as it allows
mypy
, and IDEs like VSCode, to automatically detect potential issues and provide better autocompletions. For more information onpy.typed
files, see PEP 561. We generate the file using nanobind's CMake interface.Regarding cpplint, we were until recently using version 1.6.1, which only detected missing includes for STL headers up to C++11. Among other improvements, version 2.0.0 also significantly increases its include-what-you-use check coverage -- especially new C++17 STL headers. This PR addresses all these new warnings.
Checklist: