Discussion:
[Numpy-discussion] StackOverflow documentation
Jaime Fernández del Río
2016-07-21 11:47:53 UTC
Permalink
StackOverflow now also has documentation, and there already is a NumPy tag:

http://stackoverflow.com/documentation/numpy

Not sure what, if anything, do we want to do with this, nor how to handle
not having to different sources with the same information. Any thoughts?

Jaime
--
(\__/)
( O.o)
( > <) Este es Conejo. Copia a Conejo en tu firma y ayúdale en sus planes
de dominación mundial.
Charles R Harris
2016-07-21 13:37:37 UTC
Permalink
On Thu, Jul 21, 2016 at 5:47 AM, Jaime Fernández del Río <
Post by Jaime Fernández del Río
http://stackoverflow.com/documentation/numpy
Not sure what, if anything, do we want to do with this, nor how to handle
not having to different sources with the same information. Any thoughts?
That's interesting. Not sure what to do there, maybe upload some of our
documentation? I'm a bit worried as numpy documentation changes with every
release.

Chuck
m***@telenczuk.pl
2016-07-21 14:24:15 UTC
Permalink
Post by Jaime Fernández del Río
http://stackoverflow.com/documentation/numpy
Not sure what, if anything, do we want to do with this, nor how to handle
not having to different sources with the same information. Any thoughts?
From what I understand, it's not meant to replace real documentation. It's rather a collection of crowd-sourced instructive examples with explanations:

https://stackoverflow.com/tour/documentation

Since it is run by the community, perhaps it's not a bad idea to encourage people to share their examples.

Cheers,

Bartosz
Pauli Virtanen
2016-07-21 19:10:27 UTC
Permalink
Thu, 21 Jul 2016 16:24:15 +0200, mail kirjoitti:
[clip]
Post by m***@telenczuk.pl
Since it is run by the community, perhaps it's not a bad idea to
encourage people to share their examples.
I would perhaps rather encourage people to improve the "Numpy User Guide"
or the main documentation. Of course, working on that requires a somewhat
different level of committment than editing what's essentially
Stackexchange-provided wiki (where content gets relicensed with
attribution clauses where you have to reference stackexchange and not the
original author directly).
--
Pauli Virtanen
j***@gmail.com
2016-07-21 21:59:32 UTC
Permalink
Post by Pauli Virtanen
[clip]
Post by m***@telenczuk.pl
Since it is run by the community, perhaps it's not a bad idea to
encourage people to share their examples.
I would perhaps rather encourage people to improve the "Numpy User Guide"
or the main documentation. Of course, working on that requires a somewhat
different level of committment than editing what's essentially
Stackexchange-provided wiki (where content gets relicensed with
attribution clauses where you have to reference stackexchange and not the
original author directly).
The way it looks right now, it is more of an example collection by
topic, similar to the old scipy wiki examples for numpy.
http://stackoverflow.com/documentation/python/196/comprehensions#t=201607212153155953853

It doesn't look like it will be a substitute for proper API
documentation, docstrings with numpy standard.
Longer examples or recipes on stackoverflow also have the problem that
code doesn't have a different license and falls under the
documentation license.
So, I don't think it will become a substitute for good notebook or
blog post examples either.

(license is the usual one way street, they copy, we cannot copy back
under our license)

Josef
Post by Pauli Virtanen
--
Pauli Virtanen
_______________________________________________
NumPy-Discussion mailing list
https://mail.scipy.org/mailman/listinfo/numpy-discussion
Loading...