| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
|
I've created a rough draft of the prerequisites section. Please feel free to provide feedback on style, grammar, wording or anything else you see fit. Thanks. |
Sorry, something went wrong.
There was a problem hiding this comment.
/s/describe/describes
Sorry, something went wrong.
There was a problem hiding this comment.
I'd like to reframe this section a little bit. Rather than saying that we need those tools to "create or install packages", I'd like to be more clear that these are the tools required to complete this particular tutorial. (These aren't the only tools out there, but they are the only tools we're going to require to complete the tutorial.)
Sorry, something went wrong.
|
@JoshuaAcosta Thanks for getting started on this! I really appreciate you taking the lead on this. I agree with @alexwlchan's comments and a I put a couple of my own. Overall, I think this is a great start and seeing your draft has illuminated some of the challenges of this section for me. One way we might improve this section would be to back away from assumptions about the reader's system (e.g., that they'll necessarily have x and y but not z installed) and instead check each tool in turn and provide a path forward given the results (e.g., run pip -V and say, here's how to get pip if you need it and here's how to upgrade if you don't). Would you be interested in revising it? After that, there's some nitpicky formatting issues to deal with, but I think we can work out the overall content a bit before dealing with that. Thanks again for getting started on this! |
Sorry, something went wrong.
|
Thank you very much for the feedback. I'll push the revision with a day or two. |
Sorry, something went wrong.
|
@ddbeck Please feel free to provide some feedback on the revision. I changed the overall content a bit to reflect the flow for each tool you mentioned. |
Sorry, something went wrong.
| *To install pip, setuptools and wheel, you must have a version of Python installed. You can verify if | ||
| there is a version of Python in your system by entering the following into your terminal or command prompt: | ||
|
|
||
| python -V |
There was a problem hiding this comment.
Minor thing, but I prefer using the full version of the flag:
python --version
which makes it completely obvious what this should return.
It might also be helpful to have some explanation of what the output should be – as below, something like “if a version number is returned, then Python is installed”.
Sorry, something went wrong.
There was a problem hiding this comment.
Seconding this. Using the non-abbreviated flag and describing the expected output is a good idea.
Sorry, something went wrong.
|
@JoshuaAcosta I like the changes you've made with this revision. Thank you! Here's how I think we should proceed:
If you'd let me know what you have the interest and time to do, we can go from there. Thanks again for your work on this section! |
Sorry, something went wrong.
|
@ddbeck Thanks for the feedback! I'd like a little more experience with reStructuredText so any pointers or helpful reference material would be appreciated. |
Sorry, something went wrong.
|
@JoshuaAcosta Great! Here's my notes on formatting for you:
If you have Sphinx installed, you can run make html from the root of the repository, then open build/html/prerequisites.html in a browser to check out your handiwork. Let me know if you have any questions. I'm happy to help you out on this. Thanks again! |
Sorry, something went wrong.
|
@ddbeck Made the formatting corrections you suggested. Struggled to get the hyperlink formatting right, is it correct? Let me know if anything else could use some work. Thank you for the rST guidance! @alexwlchan thanks for your help! |
Sorry, something went wrong.
|
|
||
| ==== | ||
| pip | ||
| ==== |
There was a problem hiding this comment.
Since this is a sub-section, we need to use - instead of =:
pip
---
Sorry, something went wrong.
|
@JoshuaAcosta Nice start on the formatting. The link works now. But one of the big areas that needs improvement though is the formatting of the commands. As before, it would be good to enclose them in double backticks so they stand out from the other text. Is that something you'd be comfortable taking on? If so, I'd suggest getting local builds up and running, in the root of the project: $ pip install Sphinx # if you haven't installed Sphinx yet.
$ make html # or `make.bat html` on WindowsAnd then open build/html/prerequisites.html to see your handiwork. When you make changes to your file, rerun the make html line to rebuild the output. That way you can test your formatting changes before updating your pull request. Let me know what you plan to do. Thanks! |
Sorry, something went wrong.
|
@ddbeck I've updated the file with the feedback provided. Please let me know if there are any other changes to be made. Thank you for your patience! @berkerpeksag thanks for the feedback! |
Sorry, something went wrong.
|
|
||
| To install pip, setuptools and wheel, you must have a version of Python | ||
| installed. You can verify if there is a version of Python in your | ||
| system by entering the following into your terminal or command prompt.:: |
There was a problem hiding this comment.
You've used :: to start code blocks, which is fine, but this is a bit of a shortcut that assumes you want to end the paragraph with a colon as well as start the following code block. So what we've got now is each of these, as built by Sphinx, ending with something along the lines of or command prompt.:. So you'll need to either need to drop the ending periods, or replace the double-colon code-blocks with a more verbose version like this:
…or command prompt. .. code-block:: shell python --version
Personally, I always go with the verbose version, since it's harder to surprise myself with punctuation.
Sorry, something went wrong.
There was a problem hiding this comment.
Dropping the periods would be a good start, since almost all the last sentences that :: affixes are instructions to do something, not proper sentences.
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
No description provided.