PR: Conform tutorial to docs style guide and further minor improvements #7659
Conversation
Ok, I'll trust you on this one because I don't have time to test it locally. |
|
|
||
| * We are going to use this program as a first example: | ||
| We are going to use run program as a first example: |
There was a problem hiding this comment.
You have changed "this" to "run". Did you mean to change "use" to "run" instead?
There was a problem hiding this comment.
Yes, thanks. I make embarrassing mistakes like that quite a bit when editing, and have a hard time noticing them since I tend to read what I meant, and not what I wrote.
|
|
||
| If this is your first time, you should see an output like this:: | ||
| #. If this is your first running something, you should see an output like this: |
There was a problem hiding this comment.
"time" was deleted in this change - was that accidental?
| doctoral training centre. | ||
| =============== | ||
|
|
||
| This tutorial was originally based on `notes <https://fangohr.github.io/blog/spyder-the-python-ide-spyder-23.html>`__ by `Hans Fangohr <https://fangohr.github.io/>`__, that are used at the `University of Southampton <https://www.southampton.ac.uk/>`__ to `teach Python for computational modelling <https://www.southampton.ac.uk/~fangohr/teaching/python.html>`__ to undergraduate engineers and postgraduate PhD students for the `Next Generation Computational Modelling <http://www.ngcm.soton.ac.uk/>`__ doctoral training centre. |
There was a problem hiding this comment.
Can we please change the URL "https://www.southampton.ac.uk/~fangohr/teaching/python.html" to become "https://fangohr.github.io/teaching/python.html". The former link is likely to retire at some point.
There was a problem hiding this comment.
Sure, of course.
FYI, on that updated page itself you link back to the Southampton version of the tutorial rather than the one on your site.
There was a problem hiding this comment.
Updated! Submitting a PR now.
|
This is a great pull request, improving the quality of the tutorial and Spyder. Many thanks for doing this; it looks good to me! |
|
Thanks so much for your kind words, Professor @fangohr . @ccordoba12 Since the changes are small but noticeable (2 single-word typos, 2 tiny consistency tweaks, updating the URL and rewriting a sentence) any chance we can merge it to both |
|
+This tutorial was originally based on `notes <https://fangohr.github.io/blog/spyder-the-python-ide-spyder-23.html>`__ by `Hans Fangohr <https://fangohr.github.io/>`__, that are used at the `University of Southampton <https://www.southampton.ac.uk/>`__ to `teach Python for computational modelling <https://www.southampton.ac.uk/~fangohr/teaching/python.html>`__ to undergraduate engineers and postgraduate PhD students for the `Next Generation Computational Modelling <http://www.ngcm.soton.ac.uk/>`__ doctoral training centre.
Sure, of course.
FYI, on that updated page itself you link back to the Southampton version of the tutorial rather than the one on your site.
Thanks, yes, this will change at some point, but if you point to the github.io<http://github.io> page now, then we don’t need to update the spyder site anymore.
|
|
@fangohr Yes, of course. Just wanted to point that out, heh. |
Sure, the fixes suggested by @fangohr can go to 3.x instead of master. |
|
@ccordoba12 @fangohr Thanks! Submitted as #7765 . |
Pull Request Checklist
modified the
spyder/defaultsdirectory, or added new icons/assetsDescription of Changes
A follow-on to #7641 / #7643 with the primary purpose of conforming the tutorial to our doc style guide to further enhance its appearance and external consistency, and also improve maintainability and internal consistency between them. Also, fixed some minor typos and refined the prose and formatting. See #7652 for the full list of what was done.
The final version was built with Sphinx in nitpicky mode, with no issues reported and the result was examined to confirm everything rendered well; also, it was run through Sphinx linkcheck with all green. Finally, it was examined as it will appear to users in Spyder itself reading through all sections, and no issues were found except for an issue where if ref tags (
.. _section-ref:) were placed before section headers, that header would no longer collapse once expanded. Presumably, this is a bug in Spyder's help viewer (likely whatever custom HTML/CSS/JS is used for the collapsible sections), but to work around it with minimal consequences, the reference tags were simply placed after the section headers, which worked just fine (since the links were already named manually).Overall, while the style guide changes approved in spyder-ide/spyder-docs#13 was implemented as in that issue, minimal content changes were made (compared to the previous PR); only typo fixes and minor language and format refinements, so hopefully this should be an easy review.
Thanks!
Issue(s) Resolved
Fixes #7652