Skip to content

Docs readme update #23097

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

Conversation

alexander-l-stone
Copy link

  • Helps with Improve doc/README.rst #23084
  • No tests added / passed
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • Modified the process for updating forks in docs/README.rst to use git merge instead of git rebase. Also added the git command for setting upstream to pandas.

Copy link
Member

@WillAyd WillAyd left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Do you also want to update the README to account for the non-functional python make.py build line?

@@ -108,8 +108,9 @@ the pandas code and git, see `the developer pages
When you start to work on some docs, be sure to update your code to the latest
development version ('master')::

git remote add upstream https://github.com/pandas-dev/pandas.git
Copy link
Member

Choose a reason for hiding this comment

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

Since this is really something that only ever needs to be done once would be better separated out

@WillAyd WillAyd added the Docs label Oct 11, 2018
@TomAugspurger
Copy link
Contributor

This all seems duplicative of the contributing page. How about we extract what isn't in there already and just change doc/README.rst to a link pointing to that?

@codecov
Copy link

codecov bot commented Oct 12, 2018

Codecov Report

Merging #23097 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #23097   +/-   ##
=======================================
  Coverage    92.2%    92.2%           
=======================================
  Files         169      169           
  Lines       50924    50924           
=======================================
  Hits        46952    46952           
  Misses       3972     3972
Flag Coverage Δ
#multiple 90.62% <ø> (ø) ⬆️
#single 42.3% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c8ce3d0...4df506c. Read the comment docs.

@datapythonista
Copy link
Member

+1 on what @TomAugspurger says. I personally wouldn't even bother on having a README in docs/, but if we have one, I'd just link to the contributing page.

@TomAugspurger
Copy link
Contributor

TomAugspurger commented Oct 13, 2018 via email

@jreback
Copy link
Contributor

jreback commented Nov 3, 2018

@alexander-l-stone can you update to @TomAugspurger suggestion.

@datapythonista
Copy link
Member

Closing as stale. @alexander-l-stone if you want to continue working on it, please reopen or create a new PR, and refer to #23828.

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 this pull request may close these issues.

5 participants