OpenCyphal / OpenCyphal/yakut

Add example for publishing an array type

Open
#104 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
65
Forks
14
PR merge metrics
No merged PRs in 30d

Description

https://github.com/OpenCyphal/yakut/blob/15949eac7a4f2df01b487de7a0f6484086a4ab9d/yakut/cmd/publish/_cmd.py#L78-L109

I think arrays are pretty common, but there's no example on how to publish them.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at yakut/cmd/publish/_cmd.py lines 78-109 and review how the existing publishing examples are defined. Add an example showing how to publish an array type, then verify that the example appears correctly in the publish command's user-facing help or documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.