Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update examples in README #1835

Merged
merged 3 commits into from
Apr 5, 2023
Merged

Conversation

lucaswerkmeister
Copy link
Contributor

@lucaswerkmeister lucaswerkmeister commented Apr 1, 2023

The previous output had a trailing backslash on the last hash line; while this is apparently valid for both pip-sync and pip install, IMHO it looks like a bug, and it also doesn’t reflect what pip-compile currently emits (as of version 6.12.3), so update the example.

This puts the hashes example out of sync with some of the other examples in the README, but they weren’t all in sync before either (various examples were already referencing Django 4, 3 or 2), so I hope that’s not an issue.

Contributor checklist
  • Provided the tests for the changes. – N/A
  • Assure PR title is short, clear, and good to be included in the user-oriented changelog – I’d say so? though this could probably also be left out of the changelog altogether
Maintainer checklist
  • Assure one of these labels is present: backwards incompatible, feature, enhancement, deprecation, bug, dependency, docs or skip-changelog as they determine changelog listing.
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

The previous output had a trailing backslash on the last hash line;
while this is apparently valid for both pip-sync and pip install, IMHO
it looks like a bug, and it also doesn’t reflect what pip-compile
currently emits (as of version 6.12.3), so update the example.

This puts the hashes example out of sync with some of the other examples
in the README, but they weren’t all in sync before either (various
examples were already referencing Django 4, 3 or 2), so I hope that’s
not an issue.
@webknjaz webknjaz enabled auto-merge April 1, 2023 16:48
@lucaswerkmeister
Copy link
Contributor Author

I’m not sure what to make of the CI failure, is it something that can randomly happen?

Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update! Would you like to fix the other outdated examples in the README as well?

In one case (layered requirements), I had to add a constraint on the
django-debug-toolbar version because otherwise no solution was found by
the legacy resolver. (The backtracking resolver does find a solution,
but isn’t the default yet.) This should probably be revisited later,
ideally by someone more knowledgeable than me :)
auto-merge was automatically disabled April 2, 2023 00:08

Head branch was pushed to by a user without write access

@lucaswerkmeister
Copy link
Contributor Author

Alright, I added a second commit updating the other pip-compile examples too.

@atugushev atugushev changed the title Update --generate-hashes example in README Update examples in README Apr 4, 2023
@atugushev atugushev added the docs Documentation related label Apr 4, 2023
@atugushev atugushev merged commit 09d4816 into jazzband:main Apr 5, 2023
@atugushev
Copy link
Member

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants