reword the --with help text and deprecate --without #212
Conversation
|
Kudos, SonarCloud Quality Gate passed!
|
README.md
Outdated
| * `--without`: The dependency groups to ignore when exporting. | ||
| * `--with`: The optional dependency groups to include when exporting. | ||
| * `--only`: The only dependency groups to include when exporting. | ||
| * `--with`: The dependency groups to include. By default, no groups are exported. |
There was a problem hiding this comment.
The main group is exported by default.
specify how main can be excluded
|
pre-commit.ci autofix |
|
Kudos, SonarCloud Quality Gate passed!
|
| * {{< option name="without" deprecated=true >}}The dependency groups to ignore.{{< /option >}} | ||
| * {{< option name="default" deprecated=true >}}Only export the main dependencies.{{< /option >}} | ||
| * {{< option name="dev" deprecated=true >}}Include development dependencies.{{< /option >}} |
There was a problem hiding this comment.
I'm not sure if/where this syntax works. In the end, it's https://github.com/python-poetry/poetry/blob/88096aca2300fee8d1d0babdb505e1cf50cbea17/docs/cli.md?plain=1#L706-L737 what will be displayed on the website anyway. Probably, we should choose the simpler syntax (without {{< option).
There was a problem hiding this comment.
Is this page published at all? I found it weird to have to edit the same information at 2 places. I couldn't find the first sentence of this file through a google search:
The export plugin allows the export of locked packages to various formats.
Should these files simply be deleted?
There was a problem hiding this comment.
Afaik, it's not published. However, I suppose it was the target to integrate it somehow in the poetry docs and remove the the command from https://github.com/python-poetry/poetry/blob/master/docs/cli.md. Thus, deleting it would be a step backwards. On the other hand, python-poetry/poetry#5980 got stuck since python-poetry/poetry#5980 (comment).
I just noticed, there is even a third place: https://github.com/python-poetry/poetry-plugin-export/blob/main/README.md
Since I'm not much into this topic, I'd probably just update all three spots. 🤷
This fixes #299
--withhas been updated to express that groups are never included by default--withoutoption has been marked deprecated since it serves no purpose anymore.Deprecation rationale:
--onlyalready disables--withand--without(ref)--withoutcan only remove groups that the user also provided in--with, which means that the priority (who wins? with or without?) is an implementation detail that isn't documented.