Skip to content

Commit

Permalink
DOCS-3443: Add implicit dependency examples (#3915)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT authored Jan 27, 2025
1 parent d34a397 commit 66cd9cb
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/operate/get-started/other-hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,8 @@ Edit the generated files to add your logic:

- This is the preferred method when dependencies are required, because implicit dependencies make it more clear what needs to be configured, they eliminate the need for the same attribute to be configured twice, and they make debugging easier.

- See [<file>ackermann.py</file> on GitHub](https://github.com/mcvella/viam-ackermann-base/blob/main/src/ackermann.py) for an example.

</details><br>

1. **Edit the `reconfigure` function** to do the following:
Expand Down Expand Up @@ -368,6 +370,8 @@ LOGGER.critical("critical info")

- This is the preferred method when dependencies are required, because implicit dependencies make it more clear what needs to be configured, they eliminate the need for the same attribute to be configured twice, and they make debugging easier.

- See [<file>mybase.go</file> on GitHub](https://github.com/viamrobotics/rdk/blob/main/examples/customresources/models/mybase/mybase.go) for an example.

</details><br>

1. **Edit the `Reconfigure` function** to do the following:
Expand Down

0 comments on commit 66cd9cb

Please sign in to comment.