add documentation to Mesh.boolean() #1173
Conversation
This function accepts arguments called `method` and `tol` but didn't state what they did (it was stated that `method` had two possible options but not what they were or what the difference between them was). This commit adds that information, taken from the VTK documentation and source code.
WalkthroughThe updates primarily focus on enhancing the documentation of the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Mesh
User->>Mesh: Call boolean(operation, mesh2, method, tol)
Mesh->>Mesh: Determine algorithm based on method
alt Method 0
Mesh->>Mesh: Execute Cory Quammen's algorithm
else Method 1
Mesh->>Mesh: Execute Adam Updegrove's loop algorithm
end
Mesh-->>User: Return result
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- vedo/mesh.py (1 hunks)
Additional comments not posted (1)
vedo/mesh.py (1)
2420-2427: Documentation improvements approved!The updated documentation for the
booleanmethod is clear and informative. It provides essential details about the available algorithms, their authors, and thetolparameter. Ensure that this information is accurate and reflects the method's implementation.Verification successful
Documentation accurately reflects the implementation of the
booleanmethod.The implementation of the
booleanmethod aligns with the documentation. It correctly uses the algorithms and parameters as described, ensuring users have accurate information.
- Method 0 uses
BooleanOperationPolyDataFilter.- Method 1 uses
LoopBooleanPolyDataFilter.- The
tolparameter is implemented as described.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accuracy of the documentation by checking the implementation of the `boolean` method. # Test: Search for the `boolean` method implementation. Expect: The method uses the correct algorithms and parameters as described. ast-grep --lang python --pattern $'def boolean(self, operation: str, mesh2, method=0, tol=None) -> Self:\n $$$'Length of output: 3139
This function accepts arguments called
methodandtolbut didn't state what they did (it was stated thatmethodhad two possible options but not what they were or what the difference between them was). This PR adds that information, taken from the VTK documentation and source code.