-
Notifications
You must be signed in to change notification settings - Fork 306
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
Conversation
Related to pypa#46.
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
I reviewed #200, pypi/warehouse#1627 and other related issues and added pointers about the |
✨ Thanks @brainwane! ✨ |
Add
register
documentation toREADME
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.)