From 843d16873962b179759b92c41e173eebb50eb900 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 18 Sep 2017 15:27:18 -0700 Subject: [PATCH 1/4] Add a more welcoming tone for new contributors --- doc/README.rst | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/doc/README.rst b/doc/README.rst index 0ea3234dec348..323210a52fd24 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -3,16 +3,13 @@ Contributing to the documentation ================================= -If you're not the developer type, contributing to the documentation is still -of huge value. You don't even have to be an expert on -*pandas* to do so! Something as simple as rewriting small passages for clarity -as you reference the docs is a simple but effective way to contribute. The -next person to read that passage will be in your debt! - -Actually, there are sections of the docs that are worse off by being written -by experts. If something in the docs doesn't make sense to you, updating the -relevant section after you figure it out is a simple way to ensure it will -help the next person. +Whether you are someone who loves writing, teaching, or development, +contributing to the documentation is a huge value. While some familiarity +with **pandas** is helpful, we don't expect you to be an expert to +contribute documentation. In fact, new users of **pandas** can provide +helpful improvements and clarify things that are confusing to them. By +improving the documentation even a small bit, you will be helping the +next person while gaining experience yourself. .. contents:: Table of contents: :local: From 536a6c924e960584f0c183b8a25ca5a705e2292f Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 18 Sep 2017 15:39:13 -0700 Subject: [PATCH 2/4] create doc section in whatsnew --- doc/source/whatsnew/v0.21.0.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/source/whatsnew/v0.21.0.txt b/doc/source/whatsnew/v0.21.0.txt index c808babeee5d9..e19639a00634c 100644 --- a/doc/source/whatsnew/v0.21.0.txt +++ b/doc/source/whatsnew/v0.21.0.txt @@ -583,6 +583,12 @@ PyPy - Fix :func:`DataFrame.memory_usage` to support PyPy. Objects on PyPy do not have a fixed size, so an approximation is used instead (:issue:`17228`) +Documentation +^^^^^^^^^^^^^ + +- Improved docs for documentation contributors (:issue:`17579`) + + Other ^^^^^ - Bug in :func:`eval` where the ``inplace`` parameter was being incorrectly handled (:issue:`16732`) From 029f25da259e8febc4f4ece134b6b33c623d7a0e Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Mon, 18 Sep 2017 17:31:26 -0700 Subject: [PATCH 3/4] Edit per @gfyoung review --- doc/README.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/doc/README.rst b/doc/README.rst index 323210a52fd24..ddfc0004d6536 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -3,13 +3,16 @@ Contributing to the documentation ================================= -Whether you are someone who loves writing, teaching, or development, -contributing to the documentation is a huge value. While some familiarity -with **pandas** is helpful, we don't expect you to be an expert to -contribute documentation. In fact, new users of **pandas** can provide -helpful improvements and clarify things that are confusing to them. By -improving the documentation even a small bit, you will be helping the -next person while gaining experience yourself. +If you're not the developer type, contributing to the documentation is equally +as valuable to us. You don't even have to be an expert on +*pandas* to do so! Something as simple as rewriting small passages for clarity +as you reference the docs is a simple but effective way to contribute. The +next person to read that passage will be in your debt! + +Actually, there are sections of the docs that are worse off by being written +by experts. If something in the docs doesn't make sense to you, updating the +relevant section after you figure it out is a simple way to ensure it will +help the next person. .. contents:: Table of contents: :local: From 8daa606066d1457dae861bf8816db7db72e95d0b Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Tue, 19 Sep 2017 21:44:58 -0700 Subject: [PATCH 4/4] Edit first 2 sentences and revert whatsnew change --- doc/README.rst | 8 +++++--- doc/source/whatsnew/v0.21.0.txt | 8 +------- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/doc/README.rst b/doc/README.rst index ddfc0004d6536..b2c66611b68bb 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -3,9 +3,11 @@ Contributing to the documentation ================================= -If you're not the developer type, contributing to the documentation is equally -as valuable to us. You don't even have to be an expert on -*pandas* to do so! Something as simple as rewriting small passages for clarity +Whether you are someone who loves writing, teaching, or development, +contributing to the documentation is a huge value. If you don't see yourself +as a developer type, please don't stress and know that we want you to +contribute. You don't even have to be an expert on *pandas* to do so! +Something as simple as rewriting small passages for clarity as you reference the docs is a simple but effective way to contribute. The next person to read that passage will be in your debt! diff --git a/doc/source/whatsnew/v0.21.0.txt b/doc/source/whatsnew/v0.21.0.txt index e19639a00634c..74360f06bfd02 100644 --- a/doc/source/whatsnew/v0.21.0.txt +++ b/doc/source/whatsnew/v0.21.0.txt @@ -389,7 +389,7 @@ New Behavior: --------------------------------------------------------------------------- ValueError: Of the three parameters: start, end, and periods, exactly two must be specified - In [3]: pd.period_range(start='2017Q1', end='2017Q4', periods=6, freq='Q') + In [3]: pd.period_range(start='2017Q1', end='2017Q4', periods=6, freq='Q') --------------------------------------------------------------------------- ValueError: Of the three parameters: start, end, and periods, exactly two must be specified @@ -583,12 +583,6 @@ PyPy - Fix :func:`DataFrame.memory_usage` to support PyPy. Objects on PyPy do not have a fixed size, so an approximation is used instead (:issue:`17228`) -Documentation -^^^^^^^^^^^^^ - -- Improved docs for documentation contributors (:issue:`17579`) - - Other ^^^^^ - Bug in :func:`eval` where the ``inplace`` parameter was being incorrectly handled (:issue:`16732`)