shinghim / rust-bitcoin / 10259563839

84%

push

github

Merge rust-bitcoin/rust-bitcoin#3122: Introduce helper function name policy

<a class=hub.com/shinghim/rust-bitcoin/commit/<a class="double-link" href="https://git"><a class=hub.com/shinghim/rust-bitcoin/commit/84df3438caa58263a9cbc8a41eace9c1f0fdca6b">84df3438c<a href="https://github.com/shinghim/rust-bitcoin/commit/5cca2f271d04141e1ec7d28cc07add8f2bc9b404"> Fix markdown list items (Tobin C. Harding)
<a class="double-link" href="https://github.com/shinghim/rust-bitcoin/commit/0a45c68cf8625b211109e2dbb528c73b9fa00caf">0a45c68cf</a> Introduce helper function name policy (Tobin C. Harding)

Pull request description:

  As much as it hurts the C hacker inside me we have settled on using `_internal` to mark private function names that clash with a public function of the same name.

  Introduce a policy section and rename one instance, I did not grep the codebase looking for other violations.

  This came up because I had to look at what `_inner` implied when reading the function name somewhere else.

ACKs for top commit:
  storopoli:
    ACK 84df3438caa58263a9cbc8a41eace9c1f0fdca6b
  apoelstra:
    ACK 84df3438caa58263a9cbc8a41eace9c1f0fdca6b successfully ran local tests; sgtm. should probably update rust-miniscript which uses a `real_` prefix

Tree-SHA512: aece73fac191442bbc2fa7654e75d6e81bd

3 of 3 new or added lines in 1 file covered. (100.0%)

19683 of 23653 relevant lines covered (83.22%)

15624.04 hits per line