Skip to content

Commit 3745dec

Browse files
authored
Merge pull request #10 from agoose77/docs-explain-fields
2 parents 21814bf + 5ec54e0 commit 3745dec

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,14 @@ The [metadata hook plugin](https://hatch.pypa.io/dev/plugins/metadata-hook/refer
102102

103103
### Metadata hook options
104104

105-
| Option | Type | Default | Description |
106-
|-------------------------------|-----------------|------------------|-------------------------------------------------------------------------------------------------------------|
107-
| `path` | `str` | `"package.json"` | Relative path to the `package.json` file. |
108-
| `fields` | `list` of `str` | `None` | Optional list of `pyproject.toml` fields to take from their counterparts in `package.json`. |
109-
| `contributors-as-maintainers` | `bool` | `True` | Whether contributors in `package.json` should be considered maintainers (otherwise, treat them as authors). |
110-
| `bugs-label` | `str` | `"Bug Tracker"` | The key in the URLs table of `pyproject.toml` that is populated by the `bugs` field in `package.json` |
111-
| `homepage-label` | `str` | `"Homepage"` | The key in the URLs table of `pyproject.toml` that is populated by the `homepage` field in `package.json` |
112-
| `repository-label` | `str` | `"Repository"` | The key in the URLs table of `pyproject.toml` that is populated by the `repository` field in `package.json` |
105+
| Option | Type | Default | Description |
106+
|-------------------------------|-----------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
107+
| `path` | `str` | `"package.json"` | Relative path to the `package.json` file. |
108+
| `fields` | `list` of `str` | `None` | Optional list of `pyproject.toml` fields to take from their counterparts in `package.json`. If missing, take all of the available fields. |
109+
| `contributors-as-maintainers` | `bool` | `True` | Whether contributors in `package.json` should be considered maintainers (otherwise, treat them as authors). |
110+
| `bugs-label` | `str` | `"Bug Tracker"` | The key in the URLs table of `pyproject.toml` that is populated by the `bugs` field in `package.json` |
111+
| `homepage-label` | `str` | `"Homepage"` | The key in the URLs table of `pyproject.toml` that is populated by the `homepage` field in `package.json` |
112+
| `repository-label` | `str` | `"Repository"` | The key in the URLs table of `pyproject.toml` that is populated by the `repository` field in `package.json` |
113113

114114
## License
115115

0 commit comments

Comments
 (0)