Skip to content

Commit c5c7efb

Browse files
committed
docs: fix the Unicode apostrophe issue in markdown files
1 parent 76436d6 commit c5c7efb

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

package-structure-code/python-package-distribution-files-sdist-wheel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Project metadata used to be stored in either a setup.py file or a setup.cfg file
7878

7979
### An example - xclim
8080

81-
When you publish to PyPI, you will notice that each package has metadata listed. Lets have a look at [xclim](https://pypi.org/project/xclim/), one of our [pyOpenSci packages](https://www.pyopensci.org/python-packages.html). Notice that on the PyPI landing page you see some metadata about the package including python, maintainer information and more. PyPI is able to populate this metadata because it was defined using correct syntax and classifiers by Xclim's maintainers, [pyproject.toml file](https://github.com/Ouranosinc/xclim/blob/master/pyproject.toml). This metadata when the xclim package is built, is translated into a distribution file that allows PyPI to read the metadata and print it out on their website.
81+
When you publish to PyPI, you will notice that each package has metadata listed. Let's have a look at [xclim](https://pypi.org/project/xclim/), one of our [pyOpenSci packages](https://www.pyopensci.org/python-packages.html). Notice that on the PyPI landing page you see some metadata about the package including python, maintainer information and more. PyPI is able to populate this metadata because it was defined using correct syntax and classifiers by Xclim's maintainers, [pyproject.toml file](https://github.com/Ouranosinc/xclim/blob/master/pyproject.toml). This metadata when the xclim package is built, is translated into a distribution file that allows PyPI to read the metadata and print it out on their website.
8282

8383
```{figure} ../images/python-build-package/pypi-metadata-classifiers.png
8484
:scale: 50 %

tutorials/installable-code.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ To make your Python code installable you need to create a specific directory str
8080
- Some code.
8181
- An `__init__.py` file in your code directory.
8282

83-
The directory structure youll create in this lesson will look like this:
83+
The directory structure you'll create in this lesson will look like this:
8484

8585
```bash
8686
pyospackage/ # Your project directory
@@ -118,7 +118,7 @@ import pyospackage
118118

119119
The **pyproject.toml** file is:
120120

121-
- Where you define your projects metadata (including its name, authors, license, etc)
121+
- Where you define your project's metadata (including its name, authors, license, etc)
122122
- Where you define dependencies (the packages that it depends on)
123123
- Used to specify and configure what build backend you want to use to [build your package](../package-structure-code/python-package-distribution-files-sdist-wheel).
124124

@@ -279,7 +279,7 @@ Python can support many different docstrings formats depending on the documentat
279279

280280
**pyOpenSci recommends using the NumPy Docstring convention.**
281281

282-
If you arent familiar with docstrings or typing yet, that is ok. You can review [this page in the pyOpenSci packaging guide](https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html) for an overview of both topics.
282+
If you aren't familiar with docstrings or typing yet, that is ok. You can review [this page in the pyOpenSci packaging guide](https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html) for an overview of both topics.
283283

284284
```python
285285
def add_num(a: int, b: int) -> int:
@@ -480,7 +480,7 @@ Source = "https://github.com/unknown/pyospackage"
480480
The core information that you need in a `pyproject.toml` file in order to publish on PyPI is your **package's name** and the **version**. However, we suggest that you flesh out your metadata early on in the `pyproject.toml` file.
481481

482482
Once you have your project metadata in the pyproject.toml file, you will
483-
rarely update it. In the next lesson youll add more metadata and structure to this file.
483+
rarely update it. In the next lesson you'll add more metadata and structure to this file.
484484
:::
485485

486486
## Step 5: Install your package locally

tutorials/pyproject-toml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ When creating your pyproject.toml file, consider the following:
4040
* **name=**
4141
* **version=**
4242
3. You should add more metadata to the `[project]` table as it will make it easier for users to find your project on PyPI. And it will also make it easier for installers to understand how to install your package.
43-
3. When you are adding classifiers to the **[project]** table, only use valid values from [PyPIs classifier page](https://PyPI.org/classifiers/). An invalid value here will raise an error when you build and publish your package on PyPI.
43+
3. When you are adding classifiers to the **[project]** table, only use valid values from [PyPI's classifier page](https://PyPI.org/classifiers/). An invalid value here will raise an error when you build and publish your package on PyPI.
4444
4. There is no specific order for tables in the `pyproject.toml` file. However, fields need to be placed within the correct tables. For example `requires =` always need to be in the **[build-system]** table.
4545
5. We suggest that you include your **[build-system]** table at the top of your `pyproject.toml` file.
4646
:::

0 commit comments

Comments
 (0)