Skip to content

Comments

doc(configuration): improve documentation#6254

Merged
mkniewallner merged 2 commits intopython-poetry:masterfrom
mkniewallner:doc/improve-configuration
Aug 28, 2022
Merged

doc(configuration): improve documentation#6254
mkniewallner merged 2 commits intopython-poetry:masterfrom
mkniewallner:doc/improve-configuration

Conversation

@mkniewallner
Copy link
Member

@mkniewallner mkniewallner commented Aug 27, 2022

Pull Request Check List

  • Added tests for changed code.
  • Updated documentation for changed code.

Bunch of improvements over Configuration documentation:

  • Better show default value of options
  • Add some missing Introduced in <VERSION> notes
  • Add backticks around types for better readability

Will backport to 1.2 branch before final release.

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

github-actions bot commented Aug 27, 2022 •
edited
Loading

Deploy preview for website ready!

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

Built with commit 59717b0.
This pull request is being automatically deployed with vercel-action

@mkniewallner mkniewallner marked this pull request as ready for review August 27, 2022 21:05
@mkniewallner mkniewallner requested a review from a team August 27, 2022 21:12
Secrus
Secrus previously approved these changes Aug 27, 2022
View reviewed changes
@mkniewallner
Copy link
Member Author

mkniewallner commented Aug 27, 2022

Sorry, for the last minute new commit, thought it would look better for people with OCD like me 😄

@Secrus
Copy link
Member

Secrus commented Aug 27, 2022

@mkniewallner what was that last commit about? My understanding is that you wanted to sort options alphabetically, but those seem really out of order now...

@mkniewallner
Copy link
Member Author

mkniewallner commented Aug 27, 2022

@mkniewallner what was that last commit about? My understanding is that you wanted to sort options alphabetically, but those seem really out of order now...

59717b0 and the deployed website (you can compare with the current documentation).

@Secrus
Copy link
Member

Secrus commented Aug 27, 2022

59717b0 and the deployed website (you can compare with the current documentation).

Would you mind doing top level sorting too? My OCD fires up seeing http* after virtualenv* etc...

@mkniewallner
Copy link
Member Author

mkniewallner commented Aug 27, 2022

59717b0 and the deployed website (you can compare with the current documentation).

Would you mind doing top level sorting too? My OCD fires up seeing http* after virtualenv* etc...

I didn't want to update those ones because they are all related to repositories, so kinda make sense to keep them all together.

@mkniewallner mkniewallner merged commit 73e4bde into python-poetry:master Aug 28, 2022
@mkniewallner mkniewallner deleted the doc/improve-configuration branch August 28, 2022 09:01
@mkniewallner mkniewallner mentioned this pull request Aug 28, 2022
Merged
mkniewallner added a commit that referenced this pull request Aug 28, 2022
@mkniewallner
[1.2] doc(configuration): improve documentation (#6255)
a8b1da9 
Backport of #6254.
@github-actions
Copy link

github-actions bot commented Feb 29, 2024

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.

Reviewers

@Secrus Secrus Secrus approved these changes

Assignees

No one assigned

Labels

area/docs Documentation issues/improvements

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mkniewallner @Secrus