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

Improve documentation of how the various "systems" work #18

Open
ISSOtm opened this issue Jan 3, 2024 · 0 comments
Open

Improve documentation of how the various "systems" work #18

ISSOtm opened this issue Jan 3, 2024 · 0 comments

Comments

@ISSOtm
Copy link
Owner

ISSOtm commented Jan 3, 2024

For example, document why "shadow" registers are used instead of direct writes to the hardware regs.

Avoid big chunks of documentation in the middle of a function, though, because those hinder readability of the code itself.

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

No branches or pull requests

1 participant