add code overview to docs #296
Conversation
Codecov Report
@@ Coverage Diff @@
## master #296 +/- ##
=======================================
Coverage 67.42% 67.42%
=======================================
Files 12 12
Lines 574 574
Branches 91 91
=======================================
Hits 387 387
Misses 162 162
Partials 25 25Continue to review full report at Codecov.
|
docs/index.rst
Outdated
| -------- | ||
|
|
||
| Twine is a command-line tool for interacting with PyPI securely over HTTPS. Its | ||
| command line arguments are parsed in ``twine/twine/cli.py``. Currently, twine |
There was a problem hiding this comment.
Would you be willing to share the reasoning around specifying the path as "twine/twine"? I think most people will be viewing those files as just "twine/cli.py" or "twine/commands/register.py"
There was a problem hiding this comment.
My reasoning for specifying the path as twine/twine is that is what the path is, including the twine directory that gets cloned from GitHub. If it's confusing to people, I can specify them as twine/cli.py.
There was a problem hiding this comment.
I see what you mean now. I think it's more common to do the following:
git clone https://github.com/pypa/twine
cd twine
# edit twine/cli.py
I think the custom that I've seen tends to refer to things from the root of the repository. But that certainly isn't the only way to work on projects and maybe it's better to be explicit that we are talking about working that way?
|
It seems there's a conflict in this pull request with your other pull request. Would you be willing to resolve those conflicts? |
|
Of course! I will push an updated branch. |
|
Hi @sigmavirus24 -- I have resolved the conflict. Please let me know if there is anything else you would like changes on. |
|
This is fantastic! Thanks @lgh2 👍 |
This adds a brief overview of twine's architecture to the documentation. Please let me know if there are any additions or changes.