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

RSDK-9338: add optional parameters in data client #4595

Conversation

purplenicole730
Copy link
Member

@purplenicole730 purplenicole730 commented Dec 3, 2024

Changes:

  • rename some structs for clarity
  • add optional parameter structs
  • add comments clarifying what happens if a parameter is left empty

Note as to why I didn't put all optional parameters in structs:
At first, I thought I should be putting the optional filter parameters for some of the methods in its own <method>Options struct. Thinking over it some more, I realized these functions could be seen as ones where the user is purposely leaving this parameter nil. This is in line with my discussions with Benji when we first introduced optional parameter structs. It also seemed more straightforward, especially with more clarifying comments.

@viambot viambot added the safe to test This pull request is marked safe to test from a trusted zone label Dec 3, 2024
@purplenicole730 purplenicole730 marked this pull request as ready for review December 3, 2024 17:39
@viambot viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Dec 3, 2024
Copy link
Member

@jckras jckras left a comment

Choose a reason for hiding this comment

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

left a question about the Limit parameter for DataByFilter functions otherwise LGTM! thanks for doing this nicole!

app/data_client.go Show resolved Hide resolved
app/data_client.go Show resolved Hide resolved
@viambot viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Dec 3, 2024
@purplenicole730 purplenicole730 merged commit 1fa6b1d into viamrobotics:main Dec 4, 2024
16 checks passed
@purplenicole730 purplenicole730 deleted the RSDK-9338-add-optional-parameters branch December 4, 2024 15:48
vijayvuyyuru pushed a commit to vijayvuyyuru/rdk that referenced this pull request Dec 4, 2024
vijayvuyyuru pushed a commit to vijayvuyyuru/rdk that referenced this pull request Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to test This pull request is marked safe to test from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants