-
Notifications
You must be signed in to change notification settings - Fork 190
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename Maps to PdoMaps and Map to PdoMap #431
Rename Maps to PdoMaps and Map to PdoMap #431
Conversation
Why not keep the old names as aliases coupled with DeprecationWarnings if used? That way you'll give users a chance to update their code before actually performing the breaking change. |
Mainly because there is no DeprecatedWarnings on the other change (#368) so I figured that wasn't wanted behavior. Also note that this PR doesn't break anything. We can add DeprecatedWarnings if that is what we want to have. |
Ah, I missed that you already provided aliases for the old variant; nice. I would consider adding
👍 |
While I agree, I see there is no such framework established in the existing docs. Or any change log for that matter. I'm not sure this simple PR should establish that precedence thou. |
Fair enough! |
@sveinse Could you please check if there are any references to the old names in the docs / examples? |
Yes, I did not find any more that the ones that are included in the PR. I just double checked. 👌 |
This PR renames the class
canopen.pdo.base.Map
tocanopen.pdo.base.PdoMap
and correspondingly.Map
toPdoMap
in line with the similar change as PR #368. The namesPdoMap()
andPdoMaps()
with respect to upper case "PDO" is chosen to be consistent with howSdo*
have been named.Compatibility entries have been added, so this won't break old code.