Skip to content

DOC: Add a section on future 'whatsnew' files for documentation contributions #17601

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.

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

Closed
willingc opened this issue Sep 20, 2017 · 3 comments · Fixed by #17626
Closed

DOC: Add a section on future 'whatsnew' files for documentation contributions #17601

willingc opened this issue Sep 20, 2017 · 3 comments · Fixed by #17626
Labels
Milestone

Comments

@willingc
Copy link
Contributor

In PR #17580, there has been discussion on adding a section at the end of future 'whatsnew' files for "Documentation". Adding a section like this will encourage and recognize contributors to the documentation.

@jreback jreback added the Docs label Sep 20, 2017
@jreback
Copy link
Contributor

jreback commented Sep 20, 2017

This is fine. We can put bigger changes here. We had been putting these in Other Enhancements, can just redirect them to Documentation.

@willingc can you add the whatsnew in #17580 & see if any existing notes (for 0.21.0 only) should be moved to that sub-section.

Then can close this issue with that PR as well.

@gfyoung gfyoung added this to the 0.21.0 milestone Sep 20, 2017
@TomAugspurger
Copy link
Contributor

From #17580 (comment)

My thoughts are

Pros:

pixels are cheap. Having more items in the whatsnew isn't a bad thing
Contributors get to see their work reflected in the release notes
Emphasizes that we value doc contributions, they don't have special rules
Cons:

The whatsnew is a common source of merge conflicts, which can be tough for new contributors > (but we maintainers can handle them in the web UI with little difficulty, so not a big problem)
Overall a 👍 from me

Only thing to add is that I'm like +100 on this, not just +1 :)

@gfyoung
Copy link
Member

gfyoung commented Sep 20, 2017

Only thing to add is that I'm like +100 on this

@TomAugspurger : So you're really +101? ;)

Such passionate favoring of a proposal!

jreback added a commit to jreback/pandas that referenced this issue Sep 22, 2017
jreback added a commit that referenced this issue Sep 22, 2017
alanbato pushed a commit to alanbato/pandas that referenced this issue Nov 10, 2017
No-Stream pushed a commit to No-Stream/pandas that referenced this issue Nov 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants