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

Typos in documentation #511

Closed
2 of 4 tasks
hwong557 opened this issue Jan 14, 2024 · 1 comment · Fixed by #530
Closed
2 of 4 tasks

Typos in documentation #511

hwong557 opened this issue Jan 14, 2024 · 1 comment · Fixed by #530

Comments

@hwong557
Copy link

Have you read the Contributing Guidelines on issues?

Prerequisites

  • I'm using the latest version of pact-python.
  • I have read the console error message carefully (if applicable).

Description

I found some typos, but cannot push a branch to start a PR:

ERROR: Permission to pact-foundation/pact-python.git denied to hwong557.
fatal: Could not read from remote repository.

In any case, here is a patch with the typos:

diff --git a/pact/consumer.py b/pact/consumer.py
index 5728123..6e0f6b5 100644
--- a/pact/consumer.py
+++ b/pact/consumer.py
@@ -13,7 +13,7 @@ class Consumer(object):
 
     >>> from pact import Consumer, Provider
     >>> consumer = Consumer('my-web-front-end')
-    >>> consumer.has_pact_with(Provider('my-backend-serivce'))
+    >>> consumer.has_pact_with(Provider('my-backend-service'))
     """
 
     def __init__(self, name, service_cls=Pact, tags=None,
@@ -79,7 +79,7 @@ class Consumer(object):
         >>> from pact import Consumer, Provider
         >>> consumer = Consumer('my-web-front-end')
         >>> consumer.has_pact_with(
-        ...   Provider('my-backend-serivce'),
+        ...   Provider('my-backend-service'),
         ...   host_name='192.168.1.1',
         ...   port=8000)
 
@@ -91,7 +91,7 @@ class Consumer(object):
             `localhost`.
         :type host_name: str
         :param port: The TCP port to use when contacting the Pact mock service.
-            This will need to tbe the same port used by your code under test
+            This will need to be the same port used by your code under test
             to contact the mock service. It defaults to: 1234
         :type port: int
         :param log_dir: The directory where logs should be written. Defaults to

Reproducible demo

No response

Steps to reproduce

Read the docs

Expected behavior

Not have a typo.

Actual behavior

Have a typo.

Your environment

  • Public source code:
  • Is this a consumer or provider issue? Do you have information about the other side?
  • Pact Python version used: pip list | grep pact
  • Information about your Pact broker (version, hosted where, pactflow, ...)
  • Operating system and version (e.g. Ubuntu 20.04.2 LTS, macOS Ventura):

Self-service

  • I'd be willing to fix this bug myself.
@mefellows
Copy link
Member

Thanks! If you fork the repo you should still be able to open a PR, that way the change will be credited to you

JP-Ellis added a commit that referenced this issue Jan 30, 2024
Thanks to @hwong557 for reporting these typos.

Resolves: #511
Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis added a commit that referenced this issue Jan 31, 2024
Thanks to @hwong557 for reporting these typos.

Resolves: #511
Signed-off-by: JP-Ellis <josh@jpellis.me>
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 a pull request may close this issue.

2 participants