Merging Sequential and Service API #416
Merged
Conversation
This file contains 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
added 2 commits
June 29, 2020 11:56
Thomsch
added
the
documentation
bouthilx
reviewed
Jun 30, 2020
bouthilx
approved these changes
Jun 30, 2020
Co-authored-by: Xavier Bouthillier <[email protected]>
This was referenced Nov 5, 2020
Closed
Closed
Merged
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.
Description
The documentation showcases three different levels of API: sequential, service, and framework. However, sequential and service APIs are accessible from the same module and have a similar usage making it confusing for the user. Additionally, these two APIs are fundamentally the same, except sequential is a in-memory optimization helper method, thus making its sovereignty as its own module questionable.
Changes
We merge the documentation of the two APIs. There is no need to merge the APIs' source code since this separation exists only in the doc.
Checklist
Quality
$ tox -e lint)