Repository navigation
Fix parameter names in three compas.geometry docstrings - #1538
Merged
Merged
Conversation
- Shear.from_entries: the argument is shear_entries, not shear_factors. - Polyline.split_by_length: remove the tol entry; the method has no tol argument (the docstring was copied from divide_by_length). - trimesh_gradient_numpy: the function takes one argument M = (V, F), not separate V and F arguments.
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.
Three docstrings in
compas.geometrydocument parameters that the functions do not have:Shear.from_entries(shear_entries)documented the argument asshear_factors.Polyline.split_by_length(length, strict=True)documented atolargument. The method has notol; the entry looks copied fromdivide_by_length, which does take one.trimesh_gradient_numpy(M, rtype="array")documented separateVandFarguments, but it takes a singleMand unpacks it asV, F = M(astrimesh_descent_numpycalls it,trimesh_gradient_numpy((V, F))). The entry now follows the wording of the othertrimesh_*functions that takeM.I found these by comparing the documented parameter names with the function signatures. After the change, the comparison reports no mismatch for these three functions. The doctests in
shear.pyand thesplit_by_lengthexamples still pass, andtrimesh_gradient_numpy((V, F))runs on a one-triangle mesh. Docstrings and changelog only.What type of change is this?
Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.CHANGELOG.mdfile in theUnreleasedsection under the most fitting heading (e.g.Added,Changed,Removed).invoke test).invoke lint).compas.datastructures.Mesh.