pypa / pypa/setuptools

Docs for data_files differ from the general practice

Open
#1,387 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Hi,
I was going through the docs for installing additional files when I saw that the example given contains /etc/init.d which requires sudo and is not recommended to use with pip(atleast I was told this)

It would be great if the confusion could be cleared and a clear instruction is added for a developer who wants to add the config files for the project on a a different path.

cc @buffer
Thanks

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked “Installing additional files” documentation section and review how the data_files example uses /etc/init.d. Update the guidance to explain the sudo/pip concern and clearly describe how a developer can place project configuration files at a different path.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.