You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2022/11/28 20:00:41 UTC
[datasketches-cpp] branch spellchecked-python-readme created (now cebba62)
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a change to branch spellchecked-python-readme
in repository https://gitbox.apache.org/repos/asf/datasketches-cpp.git
at cebba62 Found a number of misspellings in the Python README.
This branch includes the following new commits:
new cebba62 Found a number of misspellings in the Python README.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org
[datasketches-cpp] 01/01: Found a number of misspellings in the Python README.
Posted by le...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
leerho pushed a commit to branch spellchecked-python-readme
in repository https://gitbox.apache.org/repos/asf/datasketches-cpp.git
commit cebba6256d07cdd3d35bd77518d53d7aebe009bd
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Mon Nov 28 12:00:36 2022 -0800
Found a number of misspellings in the Python README.
---
python/README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/python/README.md b/python/README.md
index 82f267d..b5510c4 100644
--- a/python/README.md
+++ b/python/README.md
@@ -12,15 +12,15 @@ This package provides a variety of sketches as described below. Wherever a speci
## Building and Installation
-Once cloned, the library can be installed by running `python3 -m pip install .` in the project root directory -- not the python subdirectory -- which will also install the necessary dependencies, namely numpy and [pybind11[global]](https://github.com/pybind/pybind11).
+Once cloned, the library can be installed by running `python3 -m pip install .` in the project root directory -- not the python subdirectory -- which will also install the necessary dependencies, namely NumPy and [pybind11[global]](https://github.com/pybind/pybind11).
-If you prefer to call the `setup.py` build script directly, which is discoraged, you must first install `pybind11[global]`, as well as any other dependencies listed under the build-system section in `pyproject.toml`.
+If you prefer to call the `setup.py` build script directly, which is discouraged, you must first install `pybind11[global]`, as well as any other dependencies listed under the build-system section in `pyproject.toml`.
The library is also available from PyPI via `python3 -m pip install datasketches`.
## Usage
-Having installed the library, loading the Apache Datasketches Library in Python is simple: `import datasketches`.
+Having installed the library, loading the Apache DataSketches Library in Python is simple: `import datasketches`.
The unit tests are mostly structured in a tutorial style and can be used as a reference example for how to feed data into and query the different types of sketches.
@@ -76,10 +76,10 @@ The only developer-specific instructions relate to running unit tests.
### Unit tests
-The Python unit tests are run via `tox`, with no arguments, from the project root directory -- not the python subdirectory. Tox creates a temporary virtual environment in which to build and run the unit tests. In the event you are missing the necessary pacakge, tox may be installed with `python3 -m pip install --upgrade tox`.
+The Python unit tests are run via `tox`, with no arguments, from the project root directory -- not the python subdirectory. Tox creates a temporary virtual environment in which to build and run the unit tests. In the event you are missing the necessary package, tox may be installed with `python3 -m pip install --upgrade tox`.
## License
-The Apache DataSketches Library is distrubted under an Apache 2.0 License.
+The Apache DataSketches Library is distributed under the Apache 2.0 License.
There may be precompiled binaries provided as a convenience and distributed through PyPI via [https://pypi.org/project/datasketches/] contain compiled code from [pybind11](https://github.com/pybind/pybind11), which is distributed under a BSD license.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org