Skip to content

Documented features#353

Merged
apoelstra merged 3 commits intorust-bitcoin:masterfrom
Kixunil:document-features
Jan 6, 2022
Merged

Documented features#353
apoelstra merged 3 commits intorust-bitcoin:masterfrom
Kixunil:document-features

Conversation

@Kixunil
Copy link
Copy Markdown
Collaborator

@Kixunil Kixunil commented Jan 4, 2022

This documents the Cargo features making sure docs.rs shows warning for
feature-gated items. They are also explicitly spelled out in the crate
documentation.

The PR is similar in spirit to rust-bitcoin/rust-bitcoin#633

This documents the Cargo features making sure docs.rs shows warning for
feature-gated items. They are also explicitly spelled out in the crate
documentation.
Comment thread src/lib.rs Outdated
@apoelstra
Copy link
Copy Markdown
Member

ACK 1bf0552 except comment nit

Copy link
Copy Markdown
Member

@tcharding tcharding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few very minor suggestions, and some optional discussion. Thanks

Comment thread src/context.rs
Comment thread src/lib.rs Outdated
Comment thread src/lib.rs Outdated
Comment thread src/lib.rs Outdated
Comment thread src/lib.rs Outdated
Comment thread src/lib.rs
Kixunil and others added 2 commits January 4, 2022 23:16
@Kixunil
Copy link
Copy Markdown
Collaborator Author

Kixunil commented Jan 4, 2022

Fixed the comment, very good suggestion!

Copy link
Copy Markdown
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 18f74d5

I don't have any real opinion about the doccomment/attribute ordering.

RCasatta added a commit to rust-bitcoin/rust-bitcoin that referenced this pull request Jan 6, 2022
5331208 Put rustdocs above attributes (Tobin Harding)

Pull request description:

  (Trivial / Very low priority PR)

  Rust idiomatic style is to put the rustdoc _above_ any attributes on types, functions, etc.

  Audit the codebase and move comments/attributes to the correct place. Add a trailing full stop at times to neaten things up a little extra.

  Done after discussion [here](rust-bitcoin/rust-secp256k1#353 (comment))

ACKs for top commit:
  Kixunil:
    ACK 5331208
  RCasatta:
    ACK 5331208

Tree-SHA512: 7cd00dc46de813cbe3f96417bb4b13980064e10110b421224496c8b64bbe87b61b6c757cc621fde1d05754be6ecdc08acdb51fd8978e3f820d2d93f7104062d1
@apoelstra apoelstra mentioned this pull request Jan 6, 2022
@apoelstra apoelstra merged commit 88f6bae into rust-bitcoin:master Jan 6, 2022
@Kixunil Kixunil deleted the document-features branch January 6, 2022 16:48
@Kixunil Kixunil mentioned this pull request Jan 7, 2022
apoelstra added a commit that referenced this pull request Jan 7, 2022
314e875 Clarify `global-context` feature (Martin Habovstiak)
d52ab85 Added missing features to docs.rs config (Martin Habovstiak)

Pull request description:

  Sadly, I missed two details in #353: features missing in docs.rs configuration and `global-context` being a bit confusing.
  This PR fixes those, see commit messages for details.

ACKs for top commit:
  apoelstra:
    ACK 314e875

Tree-SHA512: 01bed8ae2f30adcbdd436b514f08a084492d7f4e1a739ca62e6d8b8547e379c01faeda3522733c27ab615acbb4c6cff60e13906cc88a0d2b90e439e7da517466
chain-forgexcr45 added a commit to chain-forgexcr45/rust-secp256k1 that referenced this pull request Sep 28, 2025
18f74d52422fc18f0e4c866203d7aa12c8faa3f9 Clarify what does "less security" mean (Martin Habovstiak)
94c55b4d09727433c606301d27173748c8ff36df Fixed typos/grammar mistakes (Martin Habovštiak)
1bf05523f072f833f388a1fe5e5d538fd00119c8 Documented features (Martin Habovstiak)

Pull request description:

  This documents the Cargo features making sure docs.rs shows warning for
  feature-gated items. They are also explicitly spelled out in the crate
  documentation.

  The PR is similar in spirit to rust-bitcoin/rust-bitcoin#633

ACKs for top commit:
  apoelstra:
    ACK 18f74d52422fc18f0e4c866203d7aa12c8faa3f9

Tree-SHA512: 8aac3fc5fd8ee887d6b13606d66b3d11ce44662afb92228c4f8da6169e3f70ac6a005b328f427a91d307f8d36d091dcf24bfe4d17dfc034d02b578258719a90a
william2332-limf added a commit to william2332-limf/rust-secp256k1 that referenced this pull request Oct 2, 2025
18f74d52422fc18f0e4c866203d7aa12c8faa3f9 Clarify what does "less security" mean (Martin Habovstiak)
94c55b4d09727433c606301d27173748c8ff36df Fixed typos/grammar mistakes (Martin Habovštiak)
1bf05523f072f833f388a1fe5e5d538fd00119c8 Documented features (Martin Habovstiak)

Pull request description:

  This documents the Cargo features making sure docs.rs shows warning for
  feature-gated items. They are also explicitly spelled out in the crate
  documentation.

  The PR is similar in spirit to rust-bitcoin/rust-bitcoin#633

ACKs for top commit:
  apoelstra:
    ACK 18f74d52422fc18f0e4c866203d7aa12c8faa3f9

Tree-SHA512: 8aac3fc5fd8ee887d6b13606d66b3d11ce44662afb92228c4f8da6169e3f70ac6a005b328f427a91d307f8d36d091dcf24bfe4d17dfc034d02b578258719a90a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants