-
-
Notifications
You must be signed in to change notification settings - Fork 119
DOC: edit Learn page content, and link to numpy.org/doc #258
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
Conversation
Adds a link to the NumPy docs and clearly explains the remainder of the page as external. Adds a link to the contribution info at bottom and gives it a heading.
I can't find the main discussion now, it's not gh-235. I had another look at how other sites do this. TensorFlow: Pytorch: Julia: Jupyter: I feel TensorFlow does it best: the split between |
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.
I agree that most of the textual changes are an improvement. I'm not in favor of naming this page "Documentation", since it clearly isn't. The learning/docs split is common, and we can't really rework it properly before launch. So I think I want to revert that change and merge the rest.
Learn vs Documentation I don't think the world has gotten there yet and we shouldn't be justifying our mistakes by looking at other sites' mistakes, but the call has been made, at least for now. Everything on the page is documentation
Documentation typically comes from the project, but there's nothing in the word "documentation" that limits it to being project-generated. |
Issue reference should have been gh-234, not 235; sorry for the confusion. |
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.
Rephrases are nice, thanks @bjnath. I'll push a couple of small tweaks and will then merge.
In it goes, thanks @bjnath |
I was inconsistent here; the period should be inside "Python+SciPy." too. Per Google style guide: |
Okay, I'll make these last suggested changes both here and on the data science tab. |
If we're talking last changes before launch, I'd urge changing "Get started" to "Learn NumPy." |
Ah yes, will look at that issue too. |
Follow up to numpygh-272 and numpygh-258
Adds a prominent link to the NumPy docs and clearly describes the remainder of the
page as external.
Adds a link to the contribution info at bottom and gives it a heading.
This page is still named
learn.md
! Someone will need to make the plumbing changes for this to become the Documentation page.Addresses part of issue #235.