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

Major upgrade and refactor #15

Merged
merged 21 commits into from
Jun 11, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Adjust doctest requires
  • Loading branch information
masongup-mdsol committed Jun 10, 2024

Verified

This commit was signed with the committer’s verified signature.
commit b00e86b541a5202d2af9260a64f5db3bacda6add
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -10,6 +10,8 @@ release any code to Production or deploy in a Client-accessible environment with
approval for the full stack used through the Architecture and Security groups.

```rust
use mauth_client::MAuthInfo;
use reqwest::Client;
let mauth_info = MAuthInfo::from_default_file().unwrap();
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this example should include the use statements or maybe we should have an examples/main.rs file with something that compiles and works

Copy link
Member Author

Choose a reason for hiding this comment

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

Note that this is generated from this doc test which is compiled as part of the CI test suite.

Making an example that works is problematic, since that would require an actual MAuth URL and valid private key to be stored in this public repo. I suppose I can modify it to allow the use statements to be shown though.

let client = Client::new();
let mut req = client.get("https://www.example.com/").build().unwrap();
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -9,8 +9,8 @@
//! approval for the full stack used through the Architecture and Security groups.
//!
//! ```no_run
//! # use mauth_client::MAuthInfo;
//! # use reqwest::{Client, Request, Body, Url, Method, header::HeaderValue, Response};
//! use mauth_client::MAuthInfo;
//! use reqwest::Client;
//! # async fn make_signed_request() {
//! let mauth_info = MAuthInfo::from_default_file().unwrap();
//! let client = Client::new();