Skip to content

Commit

Permalink
Minor Markdown improvement on packaging page
Browse files Browse the repository at this point in the history
Apply some minor improvements to the Markdown syntax in the pages
instruction on how to create the `pyproject.toml` file.
  • Loading branch information
santisoler authored and lwasser committed Dec 20, 2024
1 parent 46b4f54 commit 64b7cf6
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -139,12 +139,12 @@ When you create your `pyproject.toml` file, there are numerous metadata fields t

[An overview of all of the project metadata elements can be found here.](https://packaging.python.org/en/latest/specifications/core-metadata/#project-url-multiple-use)

### Required fields for the [project] table
### Required fields for the `[project]` table

As mentioned above, your pyproject.toml file needs to have a **name** and **version** field in order to properly build your package:
As mentioned above, your `pyproject.toml` file needs to have a **`name`** and **`version`** field in order to properly build your package:

- Name: This is the name of your project provided as a string
- Version: This is the version of your project. If you are using a scm tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).
- `name`: This is the name of your project provided as a string
- `version`: This is the version of your project. If you are using a SCM tool for versioning (using git tags to determine versions), then the version may be dynamic (more on that below).

### Optional fields to include in the `[project]` table

Expand Down

0 comments on commit 64b7cf6

Please sign in to comment.