[Pandas-dev] Pandas documentation sprint

[Joris Van den Bossche]

Marc, first, thanks a lot for all the work you are putting in this!

Regarding the "pandas docstring guide", I think this is certainly something
that would fit in our contributing guidelines in the pandas repo. So we
could move it there, and by opening a PR with the current text on the
pandas repo, it at the same tiem also makes it easier to comment inline on
the text there.

Joris

2018-02-14 16:03 GMT+01:00 Marc Garcia <garcia.marc at gmail.com>:

> As most of you already know, we're organizing a worldwide sprint to
> improve pandas API documentation:
> https://python-sprints.github.io/pandas/
>
> More than 15 users groups are already confirmed, and surely some more will
> join before the 10th of March. Get in touch if you want to organize one.
>
> For the sprint, we'll be preparing different resources, including a script
> to validate docstrings, a way to build an html documentation page for a
> single method, and several documents to guide participants.
>
> Among these documents, the key one is the pandas docstring standard,
> following the numpy docstring convention, but specific to pandas (and to
> the sprint). You have a draft available here:
> * https://python-sprints.github.io/pandas/guide/pandas_docstring.html
>
> As the plan is to rewrite all pandas docstrings following the guidelines
> in this document, it'd be great if you can spend a bit of time reviewing
> and discussing it. The document is just an initial proposal, the idea is to
> use it to find a consensus on how every docstring in pandas should be.
>
> This is the source code of the document at the moment (if you want to send
> a PR): https://github.com/python-sprints/python-sprints.github.
> io/blob/master/pandas/guide/source/pandas_docstring.rst We can move it to
> the pandas repo if you think that's a good idea
>
> Thanks!
>
> _______________________________________________
> Pandas-dev mailing list
> Pandas-dev at python.org
> https://mail.python.org/mailman/listinfo/pandas-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/pandas-dev/attachments/20180214/36fb6a5b/attachment.html>