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

Update README and docs index pages #292

Merged
merged 3 commits into from
Jan 27, 2018
Merged

Conversation

brainwane
Copy link
Contributor

@brainwane brainwane commented Jan 24, 2018

Add register documentation to README and add basic information to docs index.

Fixes #46.

(Incidentally, I tried to run tox -e pep8, but got: twine/utils.py:39:18: F821 undefined name 'raw_input' which I don't know how to address.)

@codecov
Copy link

codecov bot commented Jan 24, 2018

Codecov Report

Merging #292 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #292   +/-   ##
=======================================
  Coverage   67.42%   67.42%           
=======================================
  Files          12       12           
  Lines         574      574           
  Branches       91       91           
=======================================
  Hits          387      387           
+ Misses        162      161    -1     
- Partials       25       26    +1
Impacted Files Coverage Δ
twine/wininst.py 29.72% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f74eae5...0a66f85. Read the comment docs.

@erikrose
Copy link

The raw_input thing probably happens under Python 3, where all input() is raw.

README.rst Outdated
@@ -120,6 +123,47 @@ Options
containing the private key and the certificate in PEM
format

$ twine register -h
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Register needs to be deprecated and is presently broken (as pypi.org disabled that API). I'm wondering if we should document this anyway or if we should omit it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My inclination is to document it (and to mention that it is broken and about to be deprecated) until we actually deprecate it, and then to remove the documentation.

@brainwane
Copy link
Contributor Author

I reviewed #200, pypi/warehouse#1627 and other related issues and added pointers about the register command to the README.

@sigmavirus24 sigmavirus24 merged commit 5fdce8d into pypa:master Jan 27, 2018
@sigmavirus24
Copy link
Member

✨ Thanks @brainwane! ✨

@brainwane brainwane deleted the docs branch January 29, 2018 15:16
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

Successfully merging this pull request may close these issues.

3 participants