Document that the client/server features are now opt-in #58
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds documentation for the switch to the `client` and `server` features now being opt-in, rather than enabled by default (see softprops#54). I experimented with also enabling the nightly-only `doc_cfg` / `doc_auto_cfg` features (see rust-lang/rust/issues/43781, which can be used on `docs.rs` since it builds docs with nightly), however: - the features don't currently work well with the re-exports in the crate root, so require every struct/trait to be manually annotated. - the rendering isn't great - the crate landing page wrapping ended up broken So for now it seems best to not use that. I did adjust the `docs.rs` config in `Cargo.toml` to ensure docs are actually generated for all features, since previously the docs were almost empty. I also fixed a few typos / markdown syntax errors.
Closed
Merged
onalante-msft
approved these changes
Mar 16, 2022
|
Sorry this took so long to review. I had this on my to-do and forgot about it. |
|
@onalante-msft No need to be sorry! Thank you for taking a look :-) |
|
We've since dropped this as a (transitive) dependency so are no longer using this crate. Closing the PR to clean up my open PRs list. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for the switch to the
clientandserverfeatures now being opt-in, rather than enabled by default (see #54).I experimented with also enabling the nightly-only
doc_cfg/doc_auto_cfgfeatures (that allow showing feature labels in the docs, see rust-lang/rust/issues/43781), however:docs.rs(since it builds docs with nightly), they won't work for the GitHub pages version of the docs this project uses to previewmain.So for now it seems best to not use that.
I did adjust the
docs.rsconfig inCargo.tomlto ensure docs are actually generated for all features, since otherwise the docs were almost empty after #54.I also fixed a few typos / markdown syntax errors (let me know if you'd prefer these in a separate PR).