Skip to content

Comments

Add docs for multiple maintainers example#5661

Merged
Secrus merged 3 commits intopython-poetry:masterfrom
gunungpw:multimaintainers
May 28, 2022
Merged

Add docs for multiple maintainers example#5661
Secrus merged 3 commits intopython-poetry:masterfrom
gunungpw:multimaintainers

Conversation

@gunungpw
Copy link
Contributor

Pull Request Check List

Resolves: None

  • Added tests for changed code.
  • Updated documentation for changed code.
  • add an example for multiple maintainers in pyproject.toml section
  • fix license example position for consistency with other example (before NOTE)

@Secrus
Copy link
Member

Secrus commented May 22, 2022

Hi. Why do you think this change is needed? IMO docs state clearly, that maintainers is a list of maintainers. I would understand that change if the maintainers field was either single or multiple values.

@gunungpw
Copy link
Contributor Author

gunungpw commented May 27, 2022

Hello @Secrus although the documentation said this was a list of maintainers, from the perspective of new user who first time learn packaging their library/app or new to python. That was not clear how to write multiple maintainer list (formatting, toml syntax, trailing comma) and poetry it's self not yet support PEP 621 metadata. For me who have little understanding of packaging in python, documentation that have example that can be copy-paste will help a lot.
I also agree maybe we should just use multiple maintainer examples.
Thank you ❤️

@Secrus
Copy link
Member

Secrus commented May 27, 2022

@gunungpw ok, let's redo this. Please change it to only one example with multiple maintainers. Keep in mind to keep names anonymous (John and Jane Smith maybe?).

@Secrus Secrus added the area/docs Documentation issues/improvements label May 27, 2022
@github-actions
Copy link

github-actions bot commented May 27, 2022

Deploy preview for website ready!

✅ Preview
https://website-mfeq40x6v-python-poetry.vercel.app

Built with commit 70b61c3.
This pull request is being automatically deployed with vercel-action

@gunungpw
Copy link
Contributor Author

Issue have been fix, Thank you 👍

@Secrus Secrus merged commit 27034d6 into python-poetry:master May 28, 2022
@gunungpw gunungpw deleted the multimaintainers branch May 28, 2022 12:39
@abn abn mentioned this pull request Jun 6, 2022
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area/docs Documentation issues/improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants