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.

Sign up for GitHub

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

Jump to bottom

Use python -m pip install in all examples #3468

Closed
1 task done
dbeatty10 opened this issue Jun 3, 2023 · 2 comments
Closed
1 task done

Use python -m pip install in all examples #3468

dbeatty10 opened this issue Jun 3, 2023 · 2 comments
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: high Technical inaccuracy, missing/incorrect information, or broken links. Negatively affects workflows

Comments

@dbeatty10
Copy link
Contributor

dbeatty10 commented Jun 3, 2023 •
edited
Loading

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

Any page that includes pip install. (Dozens and dozens of pages!)

Use something like the following to find them:

git grep "pip install" website/docs/

What part(s) of the page would you like to see updated?

Just like the examples in the pip documentation, replace all instances of pip install with python -m pip install

Additional information

The rationale is explained well by others:

TLDR

  • Python and pip might point to different versions of Python, and the recommended syntax allow you to be very purposeful and explicit in what Python interpreter you want to be used/affected. Otherwise a 5 hour fight with issues is possible.

This is considered a universal best practice because it works regardless of the situation whereas without python -m it may or may not work as intended. Always using the best practice helps teach other people about it.
@dbeatty10 dbeatty10 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Jun 3, 2023
@runleonarun runleonarun added the priority: high Technical inaccuracy, missing/incorrect information, or broken links. Negatively affects workflows label Jun 8, 2023
@runleonarun
Copy link
Collaborator

Thanks for opening this @dbeatty10! I marked it high priority as we are not supporting a best practice in the docs.

@matthewshaver matthewshaver mentioned this issue Nov 16, 2023
Merged
3 tasks
bbrewington pushed a commit to bbrewington/fork--docs.getdbt.com that referenced this issue Nov 22, 2023
@matthewshaver
Update pip syntax (dbt-labs#4498)
fd66117 
## What are you changing in this pull request and why?

Updating the `pip install` instructions per this issue
dbt-labs#3468

## Checklist

- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [x] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."
@runleonarun
Copy link
Collaborator

runleonarun commented Jan 4, 2024 •
edited
Loading

Addressed by #4498

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear priority: high Technical inaccuracy, missing/incorrect information, or broken links. Negatively affects workflows
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@runleonarun @dbeatty10