From f65f1f49ba46685bb01dab3baf044a1bdafb8671 Mon Sep 17 00:00:00 2001 From: Dan Ryan Date: Tue, 28 Apr 2020 12:57:11 -0400 Subject: [PATCH] Add more exceptions to spelling - Remove extraneous hyphenation Signed-off-by: Dan Ryan --- CHANGELOG.rst | 14 +++++++------- docs/basics.rst | 4 ++-- docs/dev/philosophy.rst | 2 +- docs/index.rst | 2 +- docs/install.rst | 2 +- docs/spelling_wordlist.txt | 12 ++++++++++++ pipenv/cli/command.py | 10 +++++----- 7 files changed, 29 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index dd06b71181..7ce6f667a4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -60,7 +60,7 @@ Bug Fixes - Remote non-PyPI artifacts and local wheels and artifacts will now include their own hashes rather than including hashes from ``PyPI``. `#2394 `_ - Non-ascii characters will now be handled correctly when parsed by pipenv's ``ToML`` parsers. `#2737 `_ - Updated ``pipenv uninstall`` to respect the ``--skip-lock`` argument. `#2848 `_ -- Fixed a bug which caused un-installation to sometimes fail to successfully remove packages from ``Pipfiles`` with comments on preceding or following lines. `#2885 `_, +- Fixed a bug which caused uninstallation to sometimes fail to successfully remove packages from ``Pipfiles`` with comments on preceding or following lines. `#2885 `_, `#3099 `_ - Pipenv will no longer fail when encountering python versions on Windows that have been uninstalled. `#2983 `_ - Fixed unnecessary extras are added when translating markers `#3026 `_ @@ -77,7 +77,7 @@ Bug Fixes - Pipenv will avoid leaving build artifacts in the current working directory. `#3106 `_ - Fixed issues with broken subprocess calls leaking resource handles and causing random and sporadic failures. `#3109 `_ - Fixed an issue which caused ``pipenv clean`` to sometimes clean packages from the base ``site-packages`` folder or fail entirely. `#3113 `_ -- Updated ``pythonfinder`` to correct an issue with un-nesting of nested paths when searching for python versions. `#3121 `_ +- Updated ``pythonfinder`` to correct an issue with unnesting of nested paths when searching for python versions. `#3121 `_ - Added additional logic for ignoring and replacing non-ascii characters when formatting console output on non-UTF-8 systems. `#3131 `_ - Fix virtual environment discovery when ``PIPENV_VENV_IN_PROJECT`` is set, but the in-project `.venv` is a file. `#3134 `_ - Hashes for remote and local non-PyPI artifacts will now be included in ``Pipfile.lock`` during resolution. `#3145 `_ @@ -166,7 +166,7 @@ Features & Improvements - Added environment variables `PIPENV_VERBOSE` and `PIPENV_QUIET` to control output verbosity without needing to pass options. `#2527 `_ -- Updated test-PyPI add-on to better support json-api access (forward compatibility). +- Updated test-PyPI add-on to better support json-API access (forward compatibility). Improved testing process for new contributors. `#2568 `_ - Greatly enhanced python discovery functionality: @@ -178,7 +178,7 @@ Features & Improvements - Enhanced resolution of editable and VCS dependencies. `#2643 `_ -- De-duplicate and refactor CLI to use stateful arguments and object passing. See `this issue `_ for reference. `#2814 `_ +- Deduplicate and refactor CLI to use stateful arguments and object passing. See `this issue `_ for reference. `#2814 `_ Behavior Changes @@ -228,14 +228,14 @@ Bug Fixes `#2894 `_, `#2933 `_ -- Fix sub-shell invocation on Windows for Python 2. `#2515 `_ +- Fix subshell invocation on Windows for Python 2. `#2515 `_ - Fixed a bug which sometimes caused pipenv to throw a ``TypeError`` or to run into encoding issues when writing a Lockfile on python 2. `#2561 `_ - Improve quoting logic for ``pipenv run`` so it works better with Windows built-in commands. `#2563 `_ -- Fixed a bug related to parsing VCS requirements with both extras and sub-directory fragments. +- Fixed a bug related to parsing VCS requirements with both extras and subdirectory fragments. Corrected an issue in the ``requirementslib`` parser which led to some markers being discarded rather than evaluated. `#2564 `_ - Fixed multiple issues with finding the correct system python locations. `#2582 `_ @@ -364,7 +364,7 @@ Improved Documentation - Stopped recommending `--system` for Docker contexts. `#2762 `_ - Fixed the example url for doing "pipenv install -e - some-repo-url#egg=something", it was missing the "egg=" in the fragment + some-repository-url#egg=something", it was missing the "egg=" in the fragment identifier. `#2792 `_ - Fixed link to the "be cordial" essay in the contribution documentation. `#2793 `_ diff --git a/docs/basics.rst b/docs/basics.rst index ce5fc1c7b1..694fb0fa56 100644 --- a/docs/basics.rst +++ b/docs/basics.rst @@ -350,9 +350,9 @@ $ pipenv lock ☤ About Shell Configuration --------------------------- -Shells are typically mis-configured for sub-shell use, so ``$ pipenv shell --fancy`` may produce unexpected results. If this is the case, try ``$ pipenv shell``, which uses "compatibility mode", and will attempt to spawn a sub-shell despite mis-configuration. +Shells are typically misconfigured for subshell use, so ``$ pipenv shell --fancy`` may produce unexpected results. If this is the case, try ``$ pipenv shell``, which uses "compatibility mode", and will attempt to spawn a subshell despite misconfiguration. -A proper shell configuration only sets environment variables like ``PATH`` during a login session, not during every sub-shell spawn (as they are typically configured to do). In fish, this looks like this:: +A proper shell configuration only sets environment variables like ``PATH`` during a login session, not during every subshell spawn (as they are typically configured to do). In fish, this looks like this:: if status --is-login set -gx PATH /usr/local/bin $PATH diff --git a/docs/dev/philosophy.rst b/docs/dev/philosophy.rst index 3f4c0bd00e..b3461c35f3 100644 --- a/docs/dev/philosophy.rst +++ b/docs/dev/philosophy.rst @@ -13,7 +13,7 @@ Management Style `Dan Ryan `__, `Tzu-ping Chung `__, and `Nate Prewitt `__ are the core contributors. They are responsible for triaging bug reports, reviewing pull requests and ensuring that Kenneth is kept up to speed with developments around the library. -The day-to-day managing of the project is done by the core contributors. They are responsible for making judgements about whether or not a feature request is +The day-to-day managing of the project is done by the core contributors. They are responsible for making judgments about whether or not a feature request is likely to be accepted by Kenneth. Values diff --git a/docs/index.rst b/docs/index.rst index 26bfde19b2..799d778d33 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -84,7 +84,7 @@ User Testimonials - Automatically finds your project home, recursively, by looking for a ``Pipfile``. - Automatically generates a ``Pipfile``, if one doesn't exist. - Automatically creates a virtualenv in a standard location. -- Automatically adds/removes packages to a ``Pipfile`` when they are un/installed. +- Automatically adds/removes packages to a ``Pipfile`` when they are installed or uninstalled. - Automatically loads ``.env`` files, if they exist. The main commands are ``install``, ``uninstall``, and ``lock``, which generates a ``Pipfile.lock``. These are intended to replace ``$ pip install`` usage, as well as manual virtualenv management (to activate a virtualenv, run ``$ pipenv shell``). diff --git a/docs/install.rst b/docs/install.rst index 61baa591c1..97e756981c 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -71,7 +71,7 @@ Homebrew/Linuxbrew installer takes care of pip for you. =================== Pipenv is a dependency manager for Python projects. If you're familiar -with Node's `npm`_ or Ruby's `bundler`_, it is similar in spirit to those +with Node\.js's `npm`_ or Ruby's `bundler`_, it is similar in spirit to those tools. While pip can install Python packages, Pipenv is recommended as it's a higher-level tool that simplifies dependency management for common use cases. diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 2a6e908b12..219984ec6b 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -11,6 +11,7 @@ codebase Conda CPython cygwin +Deduplicate Devops eval filesystem @@ -19,6 +20,7 @@ ini installable Integrations io +js json Linuxbrew lockfile @@ -27,9 +29,12 @@ Makefile manpage metadata mingw +misconfiguration +misconfigured msys natively npm +parallelization parsers pathlib pexpect @@ -43,6 +48,7 @@ Powershell pre py pyenv +pypi PyPI pythonfinder resolvers @@ -52,6 +58,10 @@ sayers scandir sha stateful +subdirectory +subprocess +subprocesses +subshell supervisord tox Tox @@ -59,6 +69,8 @@ tracebacks triaging txt unicode +uninstallation +unnesting untrusted url urls diff --git a/pipenv/cli/command.py b/pipenv/cli/command.py index c0131ba02f..008ec47948 100644 --- a/pipenv/cli/command.py +++ b/pipenv/cli/command.py @@ -43,7 +43,7 @@ "--completion", is_flag=True, default=False, - help="Output completion (to be eval'd).", + help="Output completion (to be executed by the shell).", ) @option("--man", is_flag=True, default=False, help="Display manpage.") @option( @@ -255,14 +255,14 @@ def install( @cli.command( - short_help="Un-installs a provided package and removes it from Pipfile.", + short_help="Uninstalls a provided package and removes it from Pipfile.", context_settings=subcommand_context ) @option( "--all-dev", is_flag=True, default=False, - help="Un-install all package from [dev-packages].", + help="Uninstall all package from [dev-packages].", ) @option( "--all", @@ -280,7 +280,7 @@ def uninstall( all=False, **kwargs ): - """Un-installs a provided package and removes it from Pipfile.""" + """Uninstalls a provided package and removes it from Pipfile.""" from ..core import do_uninstall retcode = do_uninstall( packages=state.installstate.packages, @@ -440,7 +440,7 @@ def run(state, command, args): @option( "--quiet", is_flag=True, - help="Quiet stdout except vulnerability report." + help="Quiet standard output, except vulnerability report." ) @common_options @system_option