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

conflicting doc and README #17

Open
mattrunchey opened this issue Feb 15, 2019 · 0 comments
Open

conflicting doc and README #17

mattrunchey opened this issue Feb 15, 2019 · 0 comments

Comments

@mattrunchey
Copy link

In the generated components.txt :

# Whitespace is ignored.  The package name cannot contain a - character or
# other special characters.  The relative path should be the path to the
# folder containing the setup.py file for the package.

In the README.md, the example uses dashes :

For the simple case where your repository contains a single package that has its setup.py file in the root of your repository and works on python 2 and 3, you could add a line like:

project-identifier-without-spaces: ./

I presume the no dashes rule is relevant to the path names and not the actual pypi package names (many of which use dashes).

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

No branches or pull requests

1 participant