chore(docs): improve table alignment and abs links

pact-foundation · May 4, 2023 · 9bc3e21 · 9bc3e21
1 parent 80f06cf
commit 9bc3e21
Showing 1 changed file with 26 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -329,16 +329,16 @@ output, logs = verifier.verify_pacts('./userserviceclient-userservice.json')
 ```
 
 The parameters for this differ slightly in naming from their CLI equivalents:
-| CLI        |      native Python                      |
-|-----------------|-------------------------------------------------------------------------------------------------|
-| `--branch`  | `branch`                                     |
-| `--build-url`  | `build_url`                                     |
-| `--auto-detect-version-properties`  | `auto_detect_version_properties`                                     |
-| `--tag=TAG`  | `consumer_tags`                                   |
-| `--tag-with-git-branch`  | `tag_with_git_branch`                                     |
-| `PACT_DIRS_OR_FILES`  | `pact_dir`                                     |
-| `--consumer-app-version`  | `version`                                     |
-| `n/a`  | `consumer_name`                                     |
+| CLI                               |      native Python                |
+|-----------------------------------|-----------------------------------|
+| `--branch`                        | `branch`                          |
+| `--build-url`                     | `build_url`                       |
+| `--auto-detect-version-properties`| `auto_detect_version_properties`  |
+| `--tag=TAG`                       | `consumer_tags`                   |
+| `--tag-with-git-branch`           | `tag_with_git_branch`             |
+| `PACT_DIRS_OR_FILES`              | `pact_dir`                        |
+| `--consumer-app-version`          | `version`                         |
+| `n/a`                             | `consumer_name`                   |
 
 ## Verifying Pacts Against a Service
 
@@ -485,26 +485,26 @@ assert success == 0
 ```
 
 The parameters for this differ slightly in naming from their CLI equivalents:
-| CLI        |      native Python                      | notes |
-|-----------------|-------------------------------------------------------------------------------------------------|----|
-| `--log-dir`  | `log_dir`                                     ||
-| `--log-level`  | `log_level`                                     ||
-| `--provider-app-version`  | `provider_app_version`                                     ||
-| `--headers`  | `custom_provider_headers`                                     ||
-| `--consumer-version-tag`  | `consumer_tags`                                     ||
-| `--provider-version-tag`  | `provider_tags`                                     ||
-| `--provider-states-setup-url`  | `provider_states_setup_url`                                     ||
-| `--verbose`  | `verbose`                                     ||
-| `--consumer-version-selector`  | `consumer_selectors` | takes an untyped dict of consumer version selectors and converts to json |
-| `--publish-verification-results`  | `publish_verification_results`                                     | recommended only to set in CI |
-| `--provider-version-branch`  | `provider_version_branch`                                     | recommended to set |
+| CLI                               |  native Python                 | 
+|-----------------------------------|------------------------------- |
+| `--log-dir`                       | `log_dir`                      |
+| `--log-level`                     | `log_level`                    |
+| `--provider-app-version`          | `provider_app_version`         |
+| `--headers`                       | `custom_provider_headers`      |
+| `--consumer-version-tag`          | `consumer_tags`                |
+| `--provider-version-tag`          | `provider_tags`                |
+| `--provider-states-setup-url`     | `provider_states_setup_url`    |
+| `--verbose`                       | `verbose`                      |
+| `--consumer-version-selector`     | `consumer_selectors`           | 
+| `--publish-verification-results`  | `publish_verification_results` |
+| `--provider-version-branch`       | `provider_version_branch`      |
 
 
 You can see more details in the examples
 
-- [`examples/message/tests/provider/test_message_provider.py`](examples/message/tests/provider/test_message_provider.py)
-- [`examples/flask_provider/tests/provider/test_provider.py`](examples/flask_provider/tests/provider/test_provider.py)
-- [`examples/fastapi_provider/tests/provider/test_provider.py`](examples/fastapi_provider/tests/provider/test_provider.py)
+- [Message Provider Verifier Test](https://github.com/pact-foundation/pact-python/tree/master/examples/message/tests/provider/test_message_provider.py)
+- [Flask Provider Verifier Test](https://github.com/pact-foundation/pact-python/tree/master/examples/flask_provider/tests/provider/test_provider.py)
+- [FastAPI Provider Verifier Test](https://github.com/pact-foundation/pact-python/tree/master/examples/fastapi_provider/tests/provider/test_provider.py)
 
 ### Provider States
 In many cases, your contracts will need very specific data to exist on the provider