diff --git a/CHANGELOG.md b/CHANGELOG.md index d6be515..c9928f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # whl2conda changes +## [24.2.0] - *in progress* +### Bug fixes +* Correct typos in documentation. + ## [24.1.2] - 2024-1-28 ### Features diff --git a/doc/guide/basic-usage.md b/doc/guide/basic-usage.md index a058ae2..d6bfd3b 100644 --- a/doc/guide/basic-usage.md +++ b/doc/guide/basic-usage.md @@ -6,7 +6,7 @@ run `whl2conda convert`: ```bash $ whl2conda convert mypackage-1.2.3-py3-none-any.whl Reading mypackage-1.2.3-py3-none-any.whl -Writing mypackage-1.2.3-py_0.coda +Writing mypackage-1.2.3-py_0.conda ``` By default, this will create the conda package in the same directory diff --git a/doc/guide/limitations.md b/doc/guide/limitations.md index 9d45b2b..3ea3c90 100644 --- a/doc/guide/limitations.md +++ b/doc/guide/limitations.md @@ -4,7 +4,7 @@ into noarch python conda packages. It has the following limitations and known issues, some of which will be addressed in future releases. -## Arbitrary equality clause in version specifiers don't have a coda equivalent +## Arbitrary equality clause in version specifiers don't have a conda equivalent The *arbitrary equality* clause `===` is not supported by conda and there is no equivalent. This clause is also heavily discouraged diff --git a/doc/guide/renaming.md b/doc/guide/renaming.md index 5b46840..cce238b 100644 --- a/doc/guide/renaming.md +++ b/doc/guide/renaming.md @@ -87,7 +87,7 @@ You can add one or more extra package dependencies using the `-A` / `--add-depen option. This can be a conda package name and version spec, e.g.: ```bash -$ whl2conda -A 'extra-package >=1.2.3' ... +$ whl2conda convert -A 'extra-package >=1.2.3' ... ``` You can use this to add dependencies for conda packages that perhaps @@ -99,14 +99,14 @@ Likewise, you can drop packages using `-D` / `--drop-dependency` with just the package name: ```bash -$ whl2conda -D 'some-pypi-only-package' +$ whl2conda convert -D 'some-pypi-only-package' ``` This option also allows you to use [python regular expressions][python-re] to drop any package that matches a pattern: ```bash -$ whl2conda -D 'acme-.*' +$ whl2conda convert -D 'acme-.*' ``` ### Renaming dependencies @@ -120,19 +120,19 @@ be replaced with the named capture group with given name. === "plain" ```bash - $ whl2conda -R acme-widgets acme.widgets + $ whl2conda convert -R acme-widgets acme.widgets ``` === "regular expression" ``` - $ whl2conda -R 'acme-(.*)' 'acme.$1' + $ whl2conda convert -R 'acme-(.*)' 'acme.$1' ``` === "named regular expression" ``` - $ whl2conda -R 'acme-(?P.*)' 'acme.${part}' + $ whl2conda convert -R 'acme-(?P.*)' 'acme.${part}' ``` ### Renaming converted package @@ -143,7 +143,7 @@ otherwise from the name in the wheel. This can be overriden using the `--name` command line option: ```bash -$ whl2conda acme-widgets-1.2.3-py3-None-any.whl --name acme-pywidgets +$ whl2conda convert acme-widgets-1.2.3-py3-None-any.whl --name acme-pywidgets ``` ## Specifying rules in pyproject.toml file diff --git a/src/whl2conda/VERSION b/src/whl2conda/VERSION index beafbdd..5003ba8 100644 --- a/src/whl2conda/VERSION +++ b/src/whl2conda/VERSION @@ -1 +1 @@ -24.1.2 +24.2.0