Skip to content

Commit

Permalink
DRIVERS-2881 Render documentation on ReadTheDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 committed May 14, 2024
1 parent b37e463 commit 06908d4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ entire test with a note (e.g. *Removed*).

## Building Documents

We use [mkdocs](https://www.mkdocs.org/) to render the documentation. To see a live view of the documentation, run:
We use [mkdocs](https://www.mkdocs.org/) to render the documentation. To see a live view of the documentation, run:

```bash
pip install mkdocs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1265,8 +1265,8 @@ longer full, it is immediately filled. It is not a favorable situation to be in,
guarantee that the waitQueue normally provides.

Because of these issues, it does not make sense to
[go against driver mantras and provide an additional knob](../driver-mantras.md#). We may eventually pursue an alternative
configurations to address wait queue size in [Advanced Pooling Behaviors](#advanced-pooling-behaviors).
[go against driver mantras and provide an additional knob](../driver-mantras.md#). We may eventually pursue an
alternative configurations to address wait queue size in [Advanced Pooling Behaviors](#advanced-pooling-behaviors).

Users that wish to have this functionality can achieve similar results by utilizing other methods to limit concurrency.
Examples include implementing either a thread pool or an operation queue with a capped size in the user application.
Expand Down
2 changes: 1 addition & 1 deletion source/driver-mantras.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ Drivers should follow X.Y.Z versioning, where breaking API changes require a bum

Backward breaking behavior changes can be more dangerous and disruptive than backward breaking API changes. When
thinking about the implications of a behavior change, ask yourself what could happen if a user upgraded your library
without carefully reading the changelog and/or adequately testing the change.
without carefully reading the changelog and/or adequately testing the change.

0 comments on commit 06908d4

Please sign in to comment.