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

Build nu-protocol docs with all features enabled #11180

Merged
merged 1 commit into from
Nov 29, 2023

Conversation

IanManske
Copy link
Member

Description

Currently, PluginSignature does not appear on docs.rs, since it is behind the plugin feature which is not enabled by default. This PR adds metadata to the Cargo.toml to get docs.rs to build docs with all features enabled.

Copy link
Member

@sholderbach sholderbach left a comment

Choose a reason for hiding this comment

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

Great addition! (never got around to looking into this, as I dearly missed some feature gated stuff in the reedline docs)

@sholderbach sholderbach merged commit 9895208 into nushell:main Nov 29, 2023
20 checks passed
sholderbach added a commit to sholderbach/reedline that referenced this pull request Nov 29, 2023
Inspired by nushell/nushell#11180

Make sure you can see all available types/symbols on docs.rs
(e.g. `SqliteBackedHistory`)

In a second step we should take care of annotating feature gated stuff
correctly
fdncred pushed a commit to nushell/reedline that referenced this pull request Nov 29, 2023
Inspired by nushell/nushell#11180

Make sure you can see all available types/symbols on docs.rs
(e.g. `SqliteBackedHistory`)

In a second step we should take care of annotating feature gated stuff
correctly
hardfau1t pushed a commit to hardfau1t/nushell that referenced this pull request Dec 14, 2023
# Description
Currently, `PluginSignature` does not appear on
[`docs.rs`](https://docs.rs/nu-protocol/latest/nu_protocol/index.html),
since it is behind the `plugin` feature which is not enabled by default.
This PR adds [metadata](https://docs.rs/about/metadata) to the
Cargo.toml to get `docs.rs` to build docs with all features enabled.
@IanManske IanManske deleted the nu-protocol-docs-all-features branch December 17, 2023 16:34
dmatos2012 pushed a commit to dmatos2012/nushell that referenced this pull request Feb 20, 2024
# Description
Currently, `PluginSignature` does not appear on
[`docs.rs`](https://docs.rs/nu-protocol/latest/nu_protocol/index.html),
since it is behind the `plugin` feature which is not enabled by default.
This PR adds [metadata](https://docs.rs/about/metadata) to the
Cargo.toml to get `docs.rs` to build docs with all features enabled.
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.

2 participants