Skip to content

Commit

Permalink
Merge pull request #80 from zuzukin/doc
Browse files Browse the repository at this point in the history
Fix some typos in the docs
  • Loading branch information
analog-cbarber committed Sep 10, 2023
2 parents 0a3feac + 5916b12 commit 85c9388
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
8 changes: 4 additions & 4 deletions doc/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 mypackae-1.2.3-py_0.coda
Writing mypackage-1.2.3-py_0.coda
```

By default, this will create the conda package in the same directory
Expand Down Expand Up @@ -54,8 +54,8 @@ read any project-specific options from the `[tool.whl2conda]` section
then look for a wheel in the `dist/` subdirectory of the project.

If there is only one `.whl` file in the `dist/` directory, that will
be used. Otherwise, f the there is an interactive terminal and the
`--batch` option has not been specified, then *whl2conda* will prompt
be used. Otherwise, if the there is an interactive terminal and the
`--batch` option has not been specified, *whl2conda* will prompt
the user to choose a wheel or to build one using [pip wheel][pip-wheel].

You can use the `--build-wheel` option to force the wheel to be built
Expand All @@ -75,7 +75,7 @@ uses the `.tar.bz2` extension, you can use the `--format` option:
```bash
$ whl2conda convert mypackage-1.2.3-py3-none-any.whl --format V1
Reading mypackage-1.2.3-py3-none-any.whl
Writing mypackae-1.2.3-py_0.tar.bz2
Writing mypackage-1.2.3-py_0.tar.bz2
```

You can also specify the format `tree` to generate the conda package
Expand Down
9 changes: 5 additions & 4 deletions doc/limitations.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
*whl2conda* currently only supports conversion ofgeneric pure python wheels
*whl2conda* currently only supports conversion of generic pure python wheels
into noarch python conda packages.

It has the following limitations, some of which might be addressed in future
releases.

## Cannot convert from sdist

Currently, only conversion from wheels is supported. Python sdist
distributions are not currently supported. This could possibly be supported in the future.
Currently, only conversion from wheels is supported. Conversion from python sdist
distributions are not currently supported. This could possibly be supported in
the future (see [issue 78](https://github.com/zuzukin/whl2conda/issues/78)).

## Cannot convert from eggs

Expand All @@ -26,7 +27,7 @@ black[jupyter]
```

will include the `black` dependency itself, but not any extra dependencies
that are declared with the `extra == jupyter` marker. This will be addressed
that are declared with the `extra == 'jupyter'` marker. This will be addressed
in a future release. See [issue 36](https://github.com/zuzukin/whl2conda/issues/36).

## Only supports noarch python
Expand Down
4 changes: 2 additions & 2 deletions doc/renaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ exceptions, for example:
=== "pip"

```bash
$ pip install -c conda-forge numpy-quaternion
$ pip install numpy-quaternion
$ pip install tables
$ pip install torch
```
Expand Down Expand Up @@ -156,7 +156,7 @@ This is described in the [next section](pyproject.md).

We have sometimes seen problems in packages built using conda-build
in which the pip dependencies listed in the python packages
dist-info directory in the site-packages directory int the conda
dist-info directory in the site-packages directory in the conda
environment where the conda package is installed can clash with
conda dependencies. To avoid this kind of problem, the `whl2conda`
by default will turn all regular dependencies in the dist-info
Expand Down

0 comments on commit 85c9388

Please sign in to comment.