add detail to doc string in Line3DCollection #29614
Merged
Conversation
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
QuLogic
reviewed
Feb 13, 2025
lib/mpl_toolkits/mplot3d/art3d.py
Outdated
| """ | ||
| Parameters | ||
| ---------- | ||
| segments : list of (N, 3) array-like |
There was a problem hiding this comment.
This is actually named lines here.
timhoffm
reviewed
Feb 13, 2025
|
Ping @marbled-toast do you plan to continue with this? |
Ping @timhoffm I do plan to continue. I will have some time on Thursday this week. |
lib/mpl_toolkits/mplot3d/art3d.py
Outdated
| `~.path.Path.CLOSEPOLY`. | ||
|
|
||
| **kwargs | ||
| Forwarded to `.Collection`. |
There was a problem hiding this comment.
Please fix this linter error and make the line spacing for the Parameters consistent, and then it looks good to me!
|
Also, why is zorder being mentioned here? It has been a long time since I
looked at the code, but I'm pretty sure it gets ignored?
…On Wed, Mar 12, 2025 at 8:47 AM Scott Shambaugh ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In lib/mpl_toolkits/mplot3d/art3d.py
<#29614 (comment)>
:
> + antialiaseds : bool or list of bool, default: :rc:`lines.antialiased`
+ Whether to use antialiasing for each line.
+ zorder : float, default: 2
+ zorder of the lines once drawn.
+
+ facecolors : :mpltype:`color` or list of :mpltype:`color`, default: 'none'
+ When setting *facecolors*, each line is interpreted as a boundary
+ for an area, implicitly closing the path from the last point to the
+ first point. The enclosed area is filled with *facecolor*.
+ In order to manually specify what should count as the "interior" of
+ each line, please use `.PathCollection` instead, where the
+ "interior" can be specified by appropriate usage of
+ `~.path.Path.CLOSEPOLY`.
+
+ **kwargs
+ Forwarded to `.Collection`.
Please fix this linter error and make the line spacing for the Parameters
consistent, and then it looks good to me!
—
Reply to this email directly, view it on GitHub
<#29614 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AACHF6CYLBGVMCPHYXI7WPL2UAUHLAVCNFSM6AAAAABXBBNGDCVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDMNZYGM2TONZRHE>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
|
Right, |
timhoffm
reviewed
Mar 26, 2025
timhoffm
approved these changes
Apr 16, 2025
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.
PR summary
closes issue #26739
Updates
Line3DCollectiondoc string to be similar to that ofLineCollectiondoc string parameters.PR checklist