Skip to content

docs: Fix pyo3-build-config dependency advice in guide#2640

Merged
davidhewitt merged 2 commits intoPyO3:mainfrom
smheidrich:fix-guide-mult-py-build-config-dep-advice
Sep 25, 2022
Merged

docs: Fix pyo3-build-config dependency advice in guide#2640
davidhewitt merged 2 commits intoPyO3:mainfrom
smheidrich:fix-guide-mult-py-build-config-dep-advice

Conversation

@smheidrich
Copy link
Contributor

@smheidrich smheidrich commented Sep 24, 2022

Two things are wrong with the guide's advice on how to get #[cfg] flags from pyo3-build-config:

  1. The dependency's version = ... specification to be put in Cargo.toml is enclosed in double quotes instead of curly braces.
  2. Since pyo3-build-config: add a crate feature to control build script #1856, use_pyo3_cfgs() is only available if the resolve-config feature is enabled, which isn't mentioned.

This PR fixes both of these.

@smheidrich smheidrich changed the title Guide: Fix pyo3-build-config dependency advice docs: Fix pyo3-build-config dependency advice in guide Sep 24, 2022
@messense messense added the CI-skip-changelog Skip checking changelog entry label Sep 24, 2022
Copy link
Member

@davidhewitt davidhewitt left a comment

Choose a reason for hiding this comment

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

Thanks!

@davidhewitt davidhewitt merged commit 1d47286 into PyO3:main Sep 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI-skip-changelog Skip checking changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants