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

Module docstrings #1078

Open
Sxmourai opened this issue Feb 22, 2024 · 2 comments
Open

Module docstrings #1078

Sxmourai opened this issue Feb 22, 2024 · 2 comments

Comments

@Sxmourai
Copy link

Should add module docstrings to all files to explain more what they do and have some links to external docs.

@mkroening
Copy link
Member

That's true. Some modules are nicely documented, others not so much. Hopefully we'll get better in this regard over time.

Do you have any concrete issues or suggestions? :)

@Sxmourai
Copy link
Author

I want to help a bit this project, so I will look more into the architecture of this project and I will tell you a bit more what are the ones that need the most documentation
But I've already seen MMIO and fd i.e.

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

2 participants