search

emproof-com / nyxstone

Nyxstone: assembly / disassembly library based on LLVM, implemented in C++ with Rust and Python bindings, maintained by emproof.com
https://www.emproof.com
MIT License
231 stars 6 forks source link

[Rust] Remove redundant documentation #32

Closed seritools closed 7 months ago

seritools commented 8 months ago

Ok() and disassembly text on success, Err() otherwise. is implied by using Result, so it only really increases noise when looking through the documentation.

In general, I don't see a single # Returns block that is not redundant with the function signature in the public Rust API.

pkoppe commented 7 months ago

Agreed, it's a little verbose, at the same time it's not hurting the docs. We keep the comments as is for now.