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.

Sign up for GitHub

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

chore: add update to clientbuilder doc #280

Merged
merged 4 commits into from
Dec 15, 2024
Merged

chore: add update to clientbuilder doc #280

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8091539
chore: add update to clientbuilder doc
hhamud Nov 19, 2024
56b6d62
Delete README.tmp.md
hhamud Nov 19, 2024
ee1a2bb
Update lib.rs
hhamud Nov 25, 2024
cdbe647
cargo fmt
jonhoo Dec 15, 2024
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
6 changes: 6 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,12 @@
/// [`rustls`](ClientBuilder::rustls) (depending on your preference) to start the builder. If you
/// want to supply your own connector, use [`new`](ClientBuilder::new).
///
/// Note: [`geckodriver`](https://github.com/mozilla/geckodriver) does not support multiple simultaneous instances.
/// When using geckodriver, ensure you:
/// - Run only one webdriver instance at a time
/// - Explicitly close the webdriver session after use, even if an error occurs
/// To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads)

Check warning on line 171 in src/lib.rs

View workflow job for this annotation

GitHub Actions / stable / clippy 

[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
   --> src/lib.rs:171:5
    |
171 | /// To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads) 
    |     ^
    |
    = help: if this is supposed to be its own paragraph, add a blank line
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
    = note: `#[warn(clippy::doc_lazy_continuation)]` on by default
help: indent this line
    |
171 | ///   To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads) 
    |     ++

Raw Output:
src/lib.rs:171:5:w:warning: doc list item without indentation
   --> src/lib.rs:171:5
    |
171 | /// To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads) 
    |     ^
    |
    = help: if this is supposed to be its own paragraph, add a blank line
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
    = note: `#[warn(clippy::doc_lazy_continuation)]` on by default
help: indent this line
    |
171 | ///   To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads) 
    |     ++


__END__

Check warning on line 171 in src/lib.rs

View workflow job for this annotation

GitHub Actions / beta / clippy 

[clippy] reported by reviewdog 🐶
warning: doc list item without indentation
   --> src/lib.rs:171:5
    |
171 | /// To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads) 
    |     ^
    |
    = help: if this is supposed to be its own paragraph, add a blank line
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
    = note: `#[warn(clippy::doc_lazy_continuation)]` on by default
help: indent this line
    |
171 | ///   To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads) 
    |     ++

Raw Output:
src/lib.rs:171:5:w:warning: doc list item without indentation
   --> src/lib.rs:171:5
    |
171 | /// To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads) 
    |     ^
    |
    = help: if this is supposed to be its own paragraph, add a blank line
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
    = note: `#[warn(clippy::doc_lazy_continuation)]` on by default
help: indent this line
    |
171 | ///   To run multiple webdriver instances use [chromedriver](https://developer.chrome.com/docs/chromedriver/downloads) 
    |     ++


__END__
///
/// To connect to the WebDriver instance, call [`connect`](ClientBuilder::connect).
///
/// [builder]: https://rust-lang.github.io/api-guidelines/type-safety.html#c-builder
Expand Down
Loading