Repository navigation
docs: correct usage examples and current public API names - #371
Open
dajiaohuang wants to merge 1 commit into
Open
dajiaohuang wants to merge 1 commit into
dajiaohuang wants to merge 1 commit into
Conversation
This branch has not been deployed
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
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.
Problem
Several usage-guide instructions no longer match the public API on
main:test/data/filters/filters.ply, andpandas.tools.plottingno longer imports.get_k_neighbors,points_random_sampling/mesh_random_sampling, abbreviated inclination/orientation names andommnivariancedo not resolve to the current public methods/registries.voxelgrid_id; KDTree filters requirekdtree_id. Following the listed old keyword names raisesTypeError.internalargument instead ofalso_save;.npyis not a registered file format.autoclassnames are stale or refer to the wrong class.pyproject.toml(>=3.11), and one combined pytest invocation collides on repeated unit/integration module names. CI already runs the two suites separately.Changes
Correct those existing instructions and references, make the six-point points example self-contained, and synchronize the affected generated public API notes (voxelgrid arguments/defaults, sampler/filter identifiers and DataFrame sample return). No runtime behavior, dependency requirements or public interfaces change.
Validation
Windows / Python 3.12.13 / NumPy 2.2.6 / pandas 2.2.3 / SciPy 1.15.3:
8368c6aand passes all 13 after correction. Checks include executing the points example, importingscatter_matrix, actual public API calls with the documented identifiers, mesh OBJ export/reload, format/registry membership and package-metadata prerequisites.core_class.pyis unchanged after removing docstrings.python -m sphinx -E -b html docs <temporary-output>succeeds with seven existing config/developer-reference warnings outside the corrected references. This is not a warning-free whole-documentation claim.git diff --checkpasses. Repository-wide flake8 and codespell still find existing issues (including unchangedtroughin these guides). Broader runtime test limitations are unchanged from base; this is documentation-only.This does not duplicate #363's PCD URL/writer changes, and does not modify deprecated notebooks in the separate
pyntcloud-notebooksrepository.