Skip to content
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

clarify which protocols the vairous implementations conform to #171

Merged
merged 3 commits into from
Apr 3, 2024

Conversation

jtencer
Copy link
Contributor

@jtencer jtencer commented Mar 26, 2024

…some import statements

@jtencer jtencer requested review from eparish1 and fnrizzi March 26, 2024 21:10
@@ -185,7 +185,7 @@ def extents(self) -> Tuple[int, int, int]:
return self.__basis.shape


class VectorSpaceFromPOD:
class VectorSpaceFromPOD(VectorSpace):
Copy link
Member

@fnrizzi fnrizzi Mar 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't think we should do this. THis is misleading IMO because it hints at inheritance but we are more relaxed than that. It is already clear that this conforms to the protocol. Instead of this inheritance i would suggest maybe adding a comment that says that.
Also, if one changes the name of the protocol we have this too. If we don't do this, that is not a problem.
not that we will change the name, but that is the whole point of defining just an interface/protocol.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same for the other change similar

@jtencer
Copy link
Contributor Author

jtencer commented Mar 27, 2024

switched to including statement in the docstrings rather than using inheritance

@fnrizzi fnrizzi changed the title make implementations inherit from protocols for clarity and clean up … clarify which protocols the vairous implementations conform to Apr 3, 2024
@fnrizzi fnrizzi merged commit e4e8d48 into develop Apr 3, 2024
6 checks passed
@fnrizzi fnrizzi deleted the protocol_cleanup branch May 15, 2024 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants