Skip to content

Conversation

@glopesdev
Copy link
Collaborator

Array registers should be clearly indicated in the table and hyperlinks. The length of all array registers is now clearly indicated in the register specification.

Fixes #177

Array registers should be clearly indicated in the table and hyperlinks.
The length of all array registers is now clearly indicated in the
register specification.
@glopesdev glopesdev requested a review from a team November 27, 2025 22:46
@glopesdev glopesdev added the documentation Improvements or additions to documentation label Nov 27, 2025
@glopesdev glopesdev force-pushed the dev/r-version-length branch from fb42da7 to 88de5b1 Compare November 27, 2025 22:52
Copy link
Member

@bruno-f-cruz bruno-f-cruz left a comment

Choose a reason for hiding this comment

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

I am ok with merging as is.

However I still wonder if we should not explicitly state the length of registers more prominently. For instance, is it clear why the data type (eg U8) is in the title but not the length or the register? All registers have both attributes (most length =1, but still...)

@glopesdev
Copy link
Collaborator Author

However I still wonder if we should not explicitly state the length of registers more prominently.

@bruno-f-cruz the problem is we really have no more space available in the table without breaking formatting. There are tons of details per register, most of them are not even visible in the table at all, and they are in my opinion even more important than knowing the lengths of these specific registers, so it's a tradeoff. I am happy to take suggestions though.

@bruno-f-cruz
Copy link
Member

However I still wonder if we should not explicitly state the length of registers more prominently.

@bruno-f-cruz the problem is we really have no more space available in the table without breaking formatting. There are tons of details per register, most of them are not even visible in the table at all, and they are in my opinion even more important than knowing the lengths of these specific registers, so it's a tradeoff. I am happy to take suggestions though.

How about we do the following in the text:

R_FOO – Short Foo description

Address: 000
Data Type: U8
Length: 1

@glopesdev glopesdev force-pushed the dev/r-version-length branch from fc936da to ad7be16 Compare November 27, 2025 23:34
@glopesdev
Copy link
Collaborator Author

@bruno-f-cruz fair enough, I added the length to all register specifications.

@glopesdev glopesdev merged commit b2c9f90 into harp-tech:main Nov 27, 2025
1 check passed
@glopesdev glopesdev deleted the dev/r-version-length branch November 27, 2025 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

R_Version is missing register length specification

2 participants