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 undocumented modules containing one item #325

Merged
merged 3 commits into from
Jun 15, 2022

Conversation

SabrinaJewson
Copy link
Contributor

@SabrinaJewson SabrinaJewson commented Jun 15, 2022

Description

This removes the modules auth_code, auth_code_pkce, client_creds, clients::base and clients::oauth from the public API surface.

Motivation and Context

These modules are unnecessary because they only export a single item which has the same name as the module itself anyway. Documentation is easier to navigate if they’re not present.

I left out mutex because I have other plans for that module.

Dependencies

None.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

Please also list any relevant details for your test configuration

  • Test A: cargo test --features env-file

Is this change properly documented?

  • Will add a changelog entry once I have a PR number.

@marioortizmanero
Copy link
Collaborator

Awesome! That should clean up the docs a bit.

Thanks for the PR!

@marioortizmanero marioortizmanero merged commit 6914ca3 into ramsayleung:master Jun 15, 2022
@SabrinaJewson SabrinaJewson deleted the remove-modules branch June 15, 2022 14:23
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