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

Docs: "Upload your distributions" #231

Closed
guettli opened this issue Mar 21, 2016 · 6 comments
Closed

Docs: "Upload your distributions" #231

guettli opened this issue Mar 21, 2016 · 6 comments

Comments

@guettli
Copy link
Contributor

guettli commented Mar 21, 2016

Most users don't read from top to bottom.

If you look at this part, then there is one information missing:

{{{
Upload your distributions

Finally, you can upload your distributions to PyPI.

There are two options:

Use twine

twine upload dist/*

}}}
From: http://python-packaging-user-guide.readthedocs.org/en/latest/distributing/#upload-your-distributions

I am missing: Where do the files in "dist/*" come from?

I search for "dist/" on the page (ctrl-f). The matches I found did not explain where these files in this directory come from.

I don't want much, just a sentence like this:

You can now upload the files created in Link-To-Matching-Step-In-Docs with ...

@annaraven
Copy link
Contributor

So you want a phrase like "You can now upload the files created by packaging up your project as described in #packaging your project"? Given it's the very previous section, easily found by scrolling up one window(even on my tiny screen), I'm not convinced this would be helpful.

However, I could see adding something like: "The first time you run the sdist or bdist command will create a new directory in your project, called dist/, and put the new .whl or .tar.gz there." might be helpful.

Think that would be useful? You could easily find it then with ctrl-f even if you missed it in scrolling.

@guettli
Copy link
Contributor Author

guettli commented Jun 14, 2016

@annaraven Yes, your sentence would make more sense, then mine:

The first time you run the sdist or bdist command will create a new directory in your project, called dist/, and put the new .whl or .tar.gz there.

BTW, I don't like "or" in docs much. Is there a common term which matches for both file extensions?

@annaraven
Copy link
Contributor

Okay, how about "The first time you run the command to package up your project, a new directory will be created called dist/, and the new distribution file will be put there."

annaraven added a commit to annaraven/python-packaging-user-guide that referenced this issue Jun 14, 2016
Issue #pypa#231 indicated it is unclear where dist/ directory comes from or where to find it. Clarifying this situation so folks can register and upload their files to PyPI.
@ncoghlan
Copy link
Member

Closing this one based on @annaraven's PR.

@guettli
Copy link
Contributor Author

guettli commented Jun 15, 2016

Thank you for fixing this small issue.

@ncoghlan
Copy link
Member

I mentioned the wrong issue in the commit message for 094aad1 - the correct reference is to #238

ncoghlan added a commit to ncoghlan/python-packaging-user-guide that referenced this issue Jun 24, 2017
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

3 participants