m4b / goblin

An impish, cross-platform binary parsing crate, written in Rust
MIT License
1.17k stars 156 forks source link

Nearly fully documented the optional PE header. #399

Closed JohnScience closed 4 months ago

JohnScience commented 4 months ago

There's still some work needed for documentation of data directories field in the optional header but it's a separate module.

This PR also...

JohnScience commented 4 months ago

@m4b

m4b commented 4 months ago

release: non-breaking

JohnScience commented 4 months ago

to be honest this is quite a lot of documentation to review, though not a bad thing, thank you for the PR! What a strange world we're entering with gen ai though :)

my only major concerns are about the various doc aliases, they appear to alias things that don't exist, and i think that should be fixed before merging

Doc aliases improve the searchability of various items by allowing users finding them by their Windows name. See Rustdoc > Advanced features > Add aliases for an item in documentation search