PDLPorters / pdl-linearalgebra

https://p3rl.org/PDL::LinearAlgebra
1 stars 7 forks source link

make parameter 'uplo' optional for [c]tricpy #24

Closed jo-37 closed 7 months ago

jo-37 commented 7 months ago

Enable calling $m->tricpy() to extract an upper triangular matrix as discussed at PerlMonks

This change will silently break code like

sequence(3,3,2)->tricpy(indx(1, 0))
coveralls commented 7 months ago

Coverage Status

coverage: 42.475% (-0.06%) from 42.53% when pulling 35dee59aac623ea8dc7fdd1c42cb6d33c0015cbc on jo-37:contrib into 965d247d3c8e35e94324a981eca06f04da4a84bc on PDLPorters:master.

jo-37 commented 7 months ago

Thanks for your review and your suggestions, fixed so far. However, I'm not sure what you mean with "not document ctricpy at all". Shall I completely remove its POD entry?

mohawk2 commented 7 months ago

Thanks for your review and your suggestions, fixed so far. However, I'm not sure what you mean with "not document ctricpy at all". Shall I completely remove its POD entry?

Yes please. As alluded on PerlMonks, anything that helps PDL::Complex is "legacy" and shouldn't be visibly supported (even though I'm not going to delete it just yet, and even if your nice new feature does quite rightly also apply to this legacy code).

jo-37 commented 7 months ago

Moved the doc from POD to comment.

mohawk2 commented 7 months ago

It's fortunate that you did that, because it caused me to notice that you've put =for exampleS, not =for example. Sorry I missed that before. Please can you make it be spelled right for tricpy? You know how dang fussy computers can be.

I did ask you to remove the docs for ctricpy. Putting extra comments in the file makes for extra text that the maintainer (which is me) needs to mentally process whenever they need to make a change/read the code. If you would like to become the maintainer of this distro, go ahead and contribute a number of other things to it to the point that the PDL community has confidence you'll add value doing so. At that point, you can add as many comments as you like! Until then, please make the current maintainer's life easier by removing those comments.

jo-37 commented 7 months ago

Removed the comment and fixed the format.

mohawk2 commented 7 months ago

Thank you for your excellent contribution! Released as 0.38.