search

hermit-os / kernel

A Rust-based, lightweight unikernel.
http://hermit-os.org
Apache License 2.0
1.15k stars 84 forks source link

Module docstrings #1078

Open Sxmourai opened 6 months ago

Sxmourai commented 6 months ago

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

mkroening commented 6 months ago

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 commented 6 months ago

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.