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

Rename frame elements with c-style names #55

Open
jonnew opened this issue Nov 19, 2024 · 1 comment · May be fixed by #68
Open

Rename frame elements with c-style names #55

jonnew opened this issue Nov 19, 2024 · 1 comment · May be fixed by #68
Assignees
Milestone

Comments

@jonnew
Copy link
Member

jonnew commented Nov 19, 2024

The components of a frame in the hardware spec:

The frame format is:
::
uint32 Device_Address
uint64 Common_Timestamp
uint32 Sample_Size
var Sample

should be renamed (and all references as well) with c-style names that better reflect what they are. e.g.

The frame format is:

::

    uint32  dev_addr
    uint64  acqclk_cnt
    uint32  sample_sz
    var     sample

@jonnew
Copy link
Member Author

jonnew commented Nov 22, 2024

This will require a document-level review for consistency.

@bparks13 bparks13 linked a pull request Jan 13, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants