Skip to content

Commit

Permalink
Make MockRemote docstring slightly clearer
Browse files Browse the repository at this point in the history
  • Loading branch information
bitprophet committed Aug 6, 2023
1 parent 246980f commit f6f2d73
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions fabric/testing/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -289,12 +289,14 @@ class MockRemote:
By default this class is set up for start/stop style patching as opposed to
the more common context-manager or decorator approach; this is so it can be
used in situations requiring setup/teardown semantics.
Defaults to setting up a single anonymous `Session`, so it can be used as a
"request & forget" pytest fixture. Users requiring detailed remote session
expectations can call methods like `expect`, which wipe that anonymous
Session & set up a new one instead.
used in situations requiring setup/teardown semantics (such as inside a
`pytest fixture <fabric.testing.fixtures>`).
By default, this class creates a single anonymous/internal `Session`, for
convenience (eg mocking out SSH functionality as a safety measure). Users
requiring detailed remote session expectations can call methods like
`expect` or `expect_sessions`, which wipe that anonymous Session & set up a
new one instead.
.. versionadded:: 2.1
"""
Expand Down

0 comments on commit f6f2d73

Please sign in to comment.