Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge #852: Improve rustdocs for *_hash_ty methods
7638d59 Improve rusntdocs for *_hash_ty methods (Tobin Harding) Pull request description: Recently we added two new methods with rustdocs. The rustdocs have a few minor things that can be improved. - Use 'Returns' section for both success and error path returns - Use markdown heading for section - [Subjectively] improve wording of docs @rish-singhal this PR is minor rustdocs stuff that I have recently been learning myself. I hope this makes your future patches easier to do in regards to the docs. FTR there are `# Returns` sections and `# Examples` sections that one can use, no set rules as far as I can tell. I chose `# Returns` in this case because it seemed to work. Please feel free to NACK the wording changes if you do not agree. ACKs for top commit: apoelstra: ACK 7638d59 Kixunil: ACK 7638d59 Tree-SHA512: ac1629647a39789e9a162b54440798507c74501ef0a5014bc6dfe2cf5779588a304c059433b8387bbe06f413f0712d1204e4b7d912c79e31f9485f6ddcf9ceba
- Loading branch information