Skip to content

Clarify LiveServer docstring #492

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

Merged
merged 1 commit into from
Jul 4, 2017
Merged

Clarify LiveServer docstring #492

merged 1 commit into from
Jul 4, 2017

Conversation

fmoor
Copy link
Contributor

@fmoor fmoor commented Jun 16, 2017

No description provided.

@blueyed
Copy link
Contributor

blueyed commented Jun 17, 2017

What about this?

 pytest_django/live_server_helper.py | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)

diff --git i/pytest_django/live_server_helper.py w/pytest_django/live_server_helper.py
index 20f4a8a..fab888f 100644
--- i/pytest_django/live_server_helper.py
+++ w/pytest_django/live_server_helper.py
@@ -2,11 +2,7 @@
 
 
 class LiveServer(object):
-    """The liveserver fixture
-
-    This is the object that the ``live_server`` fixture returns.
-    The ``live_server`` fixture that handles creation and stopping.
-    """
+    """The class of the live_server fixture."""
 
     def __init__(self, addr):
         import django

@blueyed blueyed changed the title Clarify LiverServer docstring Clarify LiveServer docstring Jun 17, 2017
@fmoor
Copy link
Contributor Author

fmoor commented Jun 18, 2017

"The class of the live_server fixture." means that the live_server fixture itself is an instance of this class. What I understood from the original doc string is that an instance of this class is what the live_server fixture returns. These are very different things.

@pelme
Copy link
Member

pelme commented Jul 4, 2017

I think this PR looks good and improves the text. Thanks @fmoor ! ✨

@pelme pelme merged commit 21492af into pytest-dev:master Jul 4, 2017
dulacp pushed a commit to dulacp/pytest-django that referenced this pull request Dec 2, 2017
timb07 pushed a commit to timb07/pytest-django that referenced this pull request May 26, 2018
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.

3 participants