docs(conversions): correct stale converter test targets, defaults and revision - #183
Open
janickm wants to merge 1 commit into
Open
docs(conversions): correct stale converter test targets, defaults and revision#183janickm wants to merge 1 commit into
janickm wants to merge 1 commit into
Conversation
… revision Four independent staleness fixes found while cross-checking the docs against the code: - Test targets: the pytest_test macro suffixes the Python version, so :pytest_converter is not a real label. bazel test on the documented names errors out. Use :pytest_converter_3_11 (argoverse2, nuscenes). - Waymo --profile: the .rst documented a default of 'default' while both the code and the converter's own README say 'separate-sensors'. All six converters default to separate-sensors. - PAI --revision: the README said the default is 'ncore'; DEFAULT_REVISION in pai_remote/config.py is 'main', which the .rst already stated.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Four independent staleness fixes found while cross-checking the converter docs
against the code for the ncore skill in #181. Docs only, no code change.
Test targets that do not exist.
pytest_testsuffixes the Pythonversion (
bazel/pytest/defs.bzl:30), so:pytest_converteris not a reallabel and the documented command errors out with
no such target ... did you mean pylib_utils?. Fixed inargoverse2/README.md,docs/conversions/argoverse2/argoverse2.rstandnuscenes/README.md. (tools/data_converter/README.mdalready had thesuffixed form.)
Waymo
--profiledefault.waymo.rstdocumenteddefault, but bothwaymo/converter.py:1045andwaymo/README.md:43sayseparate-sensors.All six converters default to
separate-sensors.PAI
--revisiondefault.pai/README.md:157saidncore;DEFAULT_REVISIONinpai_remote/config.py:28ismain, whichpai.rst:269already stated correctly.Testing
Verified each corrected target resolves under
bazel query, and each correcteddefault against the source.
Type of Change
Checklist
bazel test //...)bazel run //:format)