[Matplotlib-devel] documentation / example review

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[Matplotlib-devel] documentation / example review

tcaswell
Folks,

We have recently been getting a lot of contributions around the prose documentation and examples (which is great!) however our review process can be very frustrating, particularly for new contributors.   I propose that we use the review threshold for documentation and examples of "Is it better than it was before?". 


Please remember to be kind and patient with new contributors! 

Tom

_______________________________________________
Matplotlib-devel mailing list
[hidden email]
https://mail.python.org/mailman/listinfo/matplotlib-devel
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: documentation / example review

Elliott Sales de Andrade
Hi all,

In related matters, I think I should point out the possibility of building docs on Circle CI again [1]. This has two benefits:
a) reduced load on Travis, meaning faster feedback for PRs, and;
b) browseable built docs *before* merging, so if someone makes a change on GitHub, they can see the actual effect on the website, or the reviewer can see it before hand, instead of waiting for a devdocs build later/building locally.

[1] https://github.com/QuLogic/matplotlib/tree/circle-docs

On 15 July 2017 at 18:26, Thomas Caswell <[hidden email]> wrote:
Folks,

We have recently been getting a lot of contributions around the prose documentation and examples (which is great!) however our review process can be very frustrating, particularly for new contributors.   I propose that we use the review threshold for documentation and examples of "Is it better than it was before?". 


Please remember to be kind and patient with new contributors! 

Tom

_______________________________________________
Matplotlib-devel mailing list
[hidden email]
https://mail.python.org/mailman/listinfo/matplotlib-devel




--
Elliott

_______________________________________________
Matplotlib-devel mailing list
[hidden email]
https://mail.python.org/mailman/listinfo/matplotlib-devel
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: documentation / example review

tcaswell
I think Nelle and Chris Holdgraf will be working on circleci related things tomorrow.

I have become :+1: on using circle for the docs to get the previews since the last time we talked about this.

Room

On Sat, Jul 15, 2017 at 5:48 PM Elliott Sales de Andrade <[hidden email]> wrote:
Hi all,

In related matters, I think I should point out the possibility of building docs on Circle CI again [1]. This has two benefits:
a) reduced load on Travis, meaning faster feedback for PRs, and;
b) browseable built docs *before* merging, so if someone makes a change on GitHub, they can see the actual effect on the website, or the reviewer can see it before hand, instead of waiting for a devdocs build later/building locally.

[1] https://github.com/QuLogic/matplotlib/tree/circle-docs

On 15 July 2017 at 18:26, Thomas Caswell <[hidden email]> wrote:
Folks,

We have recently been getting a lot of contributions around the prose documentation and examples (which is great!) however our review process can be very frustrating, particularly for new contributors.   I propose that we use the review threshold for documentation and examples of "Is it better than it was before?". 


Please remember to be kind and patient with new contributors! 

Tom

_______________________________________________
Matplotlib-devel mailing list
[hidden email]
https://mail.python.org/mailman/listinfo/matplotlib-devel




--
Elliott

_______________________________________________
Matplotlib-devel mailing list
[hidden email]
https://mail.python.org/mailman/listinfo/matplotlib-devel
Loading...