From 2c4b039f7361c9a8b01f32ac4f8c630dbf18d0ff Mon Sep 17 00:00:00 2001 From: Paulo Haddad Martim <11465075+pmhaddad@users.noreply.github.com> Date: Sun, 24 Sep 2023 04:33:52 -0300 Subject: [PATCH] Update some external links on the docs (#5943) * Fix broken URLs on docs * Adjust pip URL so header is highlighted * Update URL for TOML specs --- docs/advanced.md | 2 +- docs/pipfile.md | 2 +- docs/shell.md | 2 +- docs/workflows.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/advanced.md b/docs/advanced.md index 4c10ce80..e02126e4 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -234,7 +234,7 @@ Example: Note -Each month, [PyUp.io](https://pyup.io>)updates the `safety` database of insecure Python packages and [makes it available to the open source community for free](https://pyup.io/safety/). Each time you run `pipenv check` to show you vulnerable dependencies, +Each month, [PyUp.io](https://pyup.io) updates the `safety` database of insecure Python packages and [makes it available to the open source community for free](https://pyup.io/safety/). Each time you run `pipenv check` to show you vulnerable dependencies, Pipenv makes an API call to retrieve and use those results. For more up-to-date vulnerability data, you may also use your own safety API key by setting the environment variable `PIPENV_PYUP_API_KEY`. diff --git a/docs/pipfile.md b/docs/pipfile.md index b17a59c3..fa4e4d41 100644 --- a/docs/pipfile.md +++ b/docs/pipfile.md @@ -2,7 +2,7 @@ `Pipfile` contains the specification for the project top-level requirements and any desired specifiers. This file is managed by the developers invoking pipenv commands. -The `Pipfile` uses inline tables and the [TOML Spec](https://github.com/toml-lang/toml#user-content-spec>). +The `Pipfile` uses inline tables and the [TOML Spec](https://toml.io/en/latest#spec). `Pipfile.lock` replaces the `requirements.txt` file used in most Python projects and adds security benefits of tracking the packages hashes that were last locked. diff --git a/docs/shell.md b/docs/shell.md index 4f5dcebc..743cf89a 100644 --- a/docs/shell.md +++ b/docs/shell.md @@ -43,7 +43,7 @@ To prevent pipenv from loading the `.env` file, set the `PIPENV_DONT_LOAD_ENV` e $ PIPENV_DONT_LOAD_ENV=1 pipenv shell -See [theskumar/python-dotenv](https://github.com/theskumar/python-dotenv>) for more information on `.env` files. +See [theskumar/python-dotenv](https://github.com/theskumar/python-dotenv) for more information on `.env` files. ## Shell Completion diff --git a/docs/workflows.md b/docs/workflows.md index ddbb6950..5d790a6d 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -13,7 +13,7 @@ Add a package to your project, recalibrating entire lock file using the Pipfile $ pipenv install - Note: This will create a `Pipfile` if one doesn't exist. If one does exist, it will automatically be edited with the new package you provided, the lock file updated and the new dependencies installed. -- `pipenv install` is fully compatible with `pip install` [package specifiers](https://pip.pypa.io/en/stable/user_guide/#installing-packages>). +- `pipenv install` is fully compatible with `pip install` [package specifiers](https://pip.pypa.io/en/stable/user_guide/#installing-packages). - Additional arguments may be supplied to `pip` by supplying `pipenv` with `--extra-pip-args`. Update everything (equivalent to `pipenv lock && pipenv sync`):