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

Readme links to an outdated article #668

Closed
m-aciek opened this issue Jul 10, 2018 · 2 comments · Fixed by #1053 · May be fixed by toanant/pip-tools#1
Closed

Readme links to an outdated article #668

m-aciek opened this issue Jul 10, 2018 · 2 comments · Fixed by #1053 · May be fixed by toanant/pip-tools#1
Labels
docs Documentation related PR wanted Feature is discussed or bug is confirmed, PR needed

Comments

@m-aciek
Copy link
Contributor

m-aciek commented Jul 10, 2018

The first paragraph of Readme links to article Pin Your Packages from September 26, 2012 on @nvie's blog. Although first section (Pin Explicitly) of this article is completely up-to-date, the second one (Check for Updates Automatically) and following are not. pip-review is gone from pip-tools for a long time and one is not able to apply the article content to his own project. IMHO it's a bit confusing. Could you consider replacing link and moving Pin Your Packages rationale into Readme?

BTW I think it would be great also to have such as in Pin Your Packages but more up-to-date tutorial also in Readme (at the end?).

Environment Versions
  1. pip-tools version: 2.0.2
Steps to replicate
  1. Start to read Readme.
  2. Click on link "You do pin them, right?".
  3. Go to section "pip-review" and try to imitate commands locally with newest pip-tools installed.
Expected result

Linked article contains up-to-date content.

Actual result

Trying to reproduce example from linked article results with "pip-review: command not found".

@oleng
Copy link

oleng commented Sep 23, 2018

I second this. 6 years is a really long time ago, especially for a workflow tool.

@atugushev
Copy link
Member

Refs #883.

Could you consider replacing link and moving Pin Your Packages rationale into Readme?

BTW I think it would be great also to have such as in Pin Your Packages but more up-to-date tutorial also in Readme (at the end?).

I think it's a good idea! PR is welcomed 👍

@atugushev atugushev added PR wanted Feature is discussed or bug is confirmed, PR needed docs Documentation related labels Sep 15, 2019
toanant referenced this issue in toanant/pip-tools Oct 10, 2019
m-aciek added a commit that referenced this issue Jan 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related PR wanted Feature is discussed or bug is confirmed, PR needed
Projects
None yet
3 participants