Skip to content

DOC: Add a more welcoming tone for new contributors #17580

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Sep 20, 2017
Merged

DOC: Add a more welcoming tone for new contributors #17580

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
843d168
Add a more welcoming tone for new contributors
willingc Sep 18, 2017
536a6c9
create doc section in whatsnew
willingc Sep 18, 2017
029f25d
Edit per @gfyoung review
willingc Sep 19, 2017
8daa606
Edit first 2 sentences and revert whatsnew change
willingc Sep 20, 2017
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
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
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!
Expand Down
6 changes: 6 additions & 0 deletions doc/source/whatsnew/v0.21.0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`)


Copy link
Member

@gfyoung gfyoung Sep 18, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessary in this case. Generally, documentation changes don't get a whatsnew.
Copy link
Contributor Author

@willingc willingc Sep 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not? They're a contribution, and it demonstrates the project values a documentation contributor. 😄
Copy link
Member

@gfyoung gfyoung Sep 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think our documentation speaks for itself when it comes to how much we value it. 😄

That being said, our change-logs are generally for functional changes / bug fixes.
Copy link
Contributor Author

@willingc willingc Sep 18, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gfyoung I believe that you value it 😄

My point is that the cost of putting documentation changes at the end of the what's new are outweighed by the benefits of encouraging contributors to the documentation.
Copy link
Member

@gfyoung gfyoung Sep 19, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@willingc : Still would like to be removed. I understand where you're coming from, but we generally don't log documentation changes, just functional changes / bug fixes.
Copy link
Contributor

@TomAugspurger TomAugspurger Sep 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the past that’s what we’ve done, but I’m open to logging doc changes here. I could imagine someone reading the change log and seeing that a section has been rewritten and clicking through to see what’s changed.
Other
^^^^^
- Bug in :func:`eval` where the ``inplace`` parameter was being incorrectly handled (:issue:`16732`)
Expand Down