Update TabularDataByMQL documentation #837
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
src/viam/app/data_client.py
Outdated
| @@ -363,7 +363,8 @@ async def tabular_data_by_mql( | |||
| Args: | |||
| organization_id (str): The ID of the organization that owns the data. | |||
| You can obtain your organization ID from the Viam app's organization settings page. | |||
| query (Union[List[bytes], List[Dict[str, Any]]]): The MQL query to run as a list of BSON queries. | |||
| query (Union[List[bytes], List[Dict[str, Any]]]): "The MQL query to run, as a list of MongoDB aggregation pipeline stages. | |||
| The stages can be provided either as raw BSON bytes, or as dictionaries. | |||
There was a problem hiding this comment.
I would argue that because support for bytes will be removed, we shouldn't include bytes in the comment. We know that we want users to use dictionaries, so we shouldn't encourage alternatives, even if there is a note added below.
There was a problem hiding this comment.
Makes sense! I tweaked the language a bit so this section is now in the note. I can also just remove that part altogether and keep the note as it was before. LMK what you prefer
purplenicole730
approved these changes
Feb 6, 2025
src/viam/app/data_client.py
Outdated
Comment on lines
367
to
368
| Note: Each stage can be provided as either raw BSON bytes or as a dictionary, but support for bytes will be removed in the future, | ||
| so using a dictionary is preferred. |
There was a problem hiding this comment.
I like this change way more!
If we're keeping bytes in the comment, then I'd prefer having dictionary as the first option so that that's what people read first. as either a dictionary or raw BSON bytes. Otherwise, LGTM
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.
Context here: https://viaminc.slack.com/archives/C0307PGHR7E/p1738787849399009