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-9266: improve comments in golang module templates #4600

Conversation

purplenicole730
Copy link
Member

@purplenicole730 purplenicole730 commented Dec 4, 2024

Jira ticket

Changes:

  • add more clarifying details of what to put in config struct
  • add example config struct
  • describe what Validate() does
  • explain what path parameter is

Tested by running the module generator locally

@viambot viambot added the safe to test This pull request is marked safe to test from a trusted zone label Dec 4, 2024
@purplenicole730 purplenicole730 requested review from a team, stuqdog and lia-viam and removed request for a team December 4, 2024 18:33
@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 4, 2024
@purplenicole730 purplenicole730 marked this pull request as ready for review December 4, 2024 20:31
@purplenicole730 purplenicole730 merged commit 2496627 into viamrobotics:main Dec 5, 2024
16 checks passed
@purplenicole730 purplenicole730 deleted the RSDK-9266-improve-comments-in-golang-module-templates branch December 5, 2024 17:30
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