Skip to content

Conversation

@rossbar
Copy link
Contributor

@rossbar rossbar commented Jun 12, 2020

This is a bit of proposed cleanup following the changes to polynomial printing in #15666.

The convenience classes derived from ABCPolyBase have a nickname attribute that was only used internally in the previous implementation of __str__. After the overhaul of __str__ in #15666, this attr is no longer used anywhere internally, nor is it documented.

This change would technically break backward compatibility as the attribute was not prepended with _, but as it was an undocumented attribute that was only used internally in one specific place (and is no longer used anywhere) I thought it might be worth at least considering its removal.

The convenience classes derived from ABCPolyBase had a nickname
attribute that was only used internally in the previous
implementation of __str__. After the overhaul of __str__ in numpy#15666,
this attr is no longer used.
@rossbar
Copy link
Contributor Author

rossbar commented Jun 13, 2020

re-trigger CI

@rossbar rossbar closed this Jun 13, 2020
@rossbar rossbar reopened this Jun 13, 2020
@seberg
Copy link
Member

seberg commented Jun 27, 2020

@rossbar I think we should go ahead with it unless anyone speaks up. Its undocument, so the only one relying on it would be someone who creates new polynomials and even then it is very unlikely to affect them (worst case they have to replace the __repr__). Maybe write a sentence in the release notes in any case?

Add release note to notify users of removal of the abstract
property, and highlight users that may be affected by the
change.
@rossbar
Copy link
Contributor Author

rossbar commented Jun 29, 2020

Thanks for the feedback @seberg! I added a release note that summarizes the change and highlights users whom the change may affect.

@seberg
Copy link
Member

seberg commented Jul 8, 2020

Thanks Ross, lets put it in now, if anyone complains before the next release we can still undo.

@seberg seberg merged commit 1c8efa1 into numpy:master Jul 8, 2020
@rossbar rossbar deleted the rm_poly_nickname branch August 12, 2020 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants