Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove docsrs cfg_attributes #625

Merged
merged 1 commit into from
Jul 13, 2023
Merged

Conversation

tcharding
Copy link
Member

We no longer need to manually configure the docsrs build to highlight feature guards since we use the doc_auto_cfg feature. Somehow when we added usage of that feature we forgot to remove the other attributes.

Found in CI fail of #624

We no longer need to manually configure the docsrs build to highlight
feature guards since we use the `doc_auto_cfg` feature. Somehow when we
added usage of that feature we forgot to remove the other attributes.
Copy link
Member

@sanket1729 sanket1729 left a comment

Choose a reason for hiding this comment

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

utACK 81b154f. I don't follow this completely, but yay for removing unnecessary code.

@tcharding
Copy link
Member Author

Using #![cfg_attr(docsrs, feature(doc_auto_cfg))] we no longer need to add all these attributes, the feature guarded code gets documented correctly auto-magically.

@tcharding tcharding mentioned this pull request Jul 13, 2023
Copy link
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 81b154f

@apoelstra apoelstra merged commit 8e48e15 into rust-bitcoin:master Jul 13, 2023
17 checks passed
@tcharding tcharding deleted the 07-13-docsrs branch July 14, 2023 03:02
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