Skip to content

Fix missing feature flags in implementation of Either conversion.#3722

Merged
davidhewitt merged 3 commits intorelease-0.20from
fix-doc-build
Jan 2, 2024
Merged

Fix missing feature flags in implementation of Either conversion.#3722
davidhewitt merged 3 commits intorelease-0.20from
fix-doc-build

Conversation

@adamreichold
Copy link
Member

No description provided.

@adamreichold adamreichold added the CI-skip-changelog Skip checking changelog entry label Jan 2, 2024
@adamreichold
Copy link
Member Author

Since we'd need to do a 0.20.2 release to fix our doc builds, we might want to backport #3721 as well.

@adamreichold
Copy link
Member Author

Another thing we want to add here is a CI step (at least for full builds) matching docs.rs, i.e. using a nightly rustdoc and the features and cfgs defined via package.metadata.docs.rs.

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 for catching this, I agree we should do a patch release to fixup docs, and a CI job is a very good idea.

- uses: dtolnay/rust-toolchain@nightly
with:
components: rust-src
- run: cargo rustdoc --lib --no-default-features --features "macros num-bigint num-complex hashbrown serde multiple-pymethods indexmap eyre either chrono rust_decimal" -Zunstable-options --config "build.rustdocflags=[\"--cfg\", \"docsrs\"]"
Copy link
Member

Choose a reason for hiding this comment

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

It looks like the difference between this and full is that it doesn't include experimental-inspect but does include multiple-pymethods.

To help keep things consistent should we take experimental-inspect out of full (and manually add it back in to relevant CI jobs) and then make this

Suggested change
- run: cargo rustdoc --lib --no-default-features --features "macros num-bigint num-complex hashbrown serde multiple-pymethods indexmap eyre either chrono rust_decimal" -Zunstable-options --config "build.rustdocflags=[\"--cfg\", \"docsrs\"]"
- run: cargo rustdoc --lib --no-default-features --features full -Zunstable-options --config "build.rustdocflags=[\"--cfg\", \"docsrs\"]"

(Or --features "full multiple-pymethods", but I think multiple-pymethods has no documentation differences, just internal machinery.)

Copy link
Member

Choose a reason for hiding this comment

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

(Or maybe we should be documenting experimental-inspect also; it might help people notice the feature and motivate someone to come along and help finish it off.)

Copy link
Member Author

Choose a reason for hiding this comment

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

I think documenting experimental-inspect would be preferable. Or rather, I think the only reason to not document a feature is if it breaks the docs.rs build or we do not want people to use it, neither of which appears to be the case here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added a commit unifying the docs.rs and full builds.

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.

Perfect, thanks!

@davidhewitt davidhewitt merged commit f789385 into release-0.20 Jan 2, 2024
@davidhewitt davidhewitt deleted the fix-doc-build branch January 2, 2024 19:52
@davidhewitt davidhewitt mentioned this pull request Jan 2, 2024
@utkarshgupta137
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI-build-full CI-skip-changelog Skip checking changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants