Document public getters to return Dispatchable(De)serializers #239
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
thiemowmde force-pushed the publicInterfaces branch from 826b5ad to 26fe3f7 Compare 
thiemowmde force-pushed the publicInterfaces branch from 26fe3f7 to 57d7652 Compare 
thiemowmde commented Oct 26, 2017
| * @return Serializer | ||
| * @return DispatchableSerializer | ||
| */ | ||
| public function newStatementSerializer() { |
Contributor Author
There was a problem hiding this comment.
I touched this because the corresponding deserializer is already documented as "dispatchable".
This is for a historical reason: certain API modules have been designed in a way they can accept both statement as well as claim serializations. Therefor statement and claim serializers and deserializers must be dispatchable. And they are, it's just the documentation that is misleading. I think we should fix this, even if we are not using this as a feature at the moment.
Member
| +1 sounds sensible |
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.
To know this is critical for external callers as well as internally. Look how the newEntityDeserializer method uses the return values from newItemDeserializer and newPropertyDeserializer: in a DispatchingDeserializer, which requires the values to be of type DispatchableDeserializer. Same is true for usages outside of this component. So this information is already public, just not documented properly.