Skip to content

Commit

Permalink
Merge pull request #133 from zuzukin/coda-typo
Browse files Browse the repository at this point in the history
documentation typos
  • Loading branch information
analog-cbarber authored Feb 9, 2024
2 parents f8ac641 + 2f0100e commit 79c5a51
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 10 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# whl2conda changes

## [24.2.0] - *in progress*
### Bug fixes
* Correct typos in documentation.

## [24.1.2] - 2024-1-28

### Features
Expand Down
2 changes: 1 addition & 1 deletion doc/guide/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/guide/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions doc/guide/renaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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-.*'
```

### <a name="manual-rename">Renaming dependencies</a>
Expand All @@ -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<part>.*)' 'acme.${part}'
$ whl2conda convert -R 'acme-(?P<part>.*)' 'acme.${part}'
```

### Renaming converted package
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/whl2conda/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
24.1.2
24.2.0

0 comments on commit 79c5a51

Please sign in to comment.