suggested additions to documentation of API versions #747
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
|
This is great. I think it should go in coordinated with other changes to document v2. So far, there has been zero documentation of the databroker 2.x pre-release, only the tiled documentation. |
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.
From a conversation on nakea slack, I would love to highlight the differences between the databroker API version and the databroker software version. Furthermore, the documentation on API versions does not quite capture the differences between the API v2 and the tiled-supported version of databroker, which I think is like v2 but with different initialization.
Description
I added to the main table of API version the version of databroker software supported. I also tried to highlight the subtlety of API
v2andv2 with tiled. If this approach to the documentation is deemed worthy, we should also an initialization example, for which this PR currently only adds a placeholder.