Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Doc changes to git setup #14752

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

Jump to bottom
Merged
merged 1 commit into from
Jul 18, 2019
Merged

Doc changes to git setup #14752

merged 1 commit into from
Jul 18, 2019

Conversation

RebeccaWPerry
Copy link
Contributor

PR Summary

Small doc changes to help new devs set up git. Removed "Of course..." because words like "of course" and "just do..." can be off-putting to people who don't see what follows as obvious.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@jklymak
Copy link
Member

jklymak commented Jul 13, 2019

I think this section gets copied over from the gitwash repository so I think you need to make the PR there.

@dstansby
Copy link
Member

Thanks for the PR @RebeccaWPerry. To elaborate, these bits of the docs are copied from here: https://github.com/matthew-brett/gitwash - it looks like that repository hasn't been updated in about 2 years though and is dead, so maybe we should just put the changes directly into Matplotlib?

@RebeccaWPerry
Copy link
Contributor Author

@dstansby haha, oops! Was just trying to make a simple doc change as my first PR. It does look like gitwash is pretty ignored. Including some PR's from @tacaswell.

@anntzer
Copy link
Contributor

anntzer commented Jul 13, 2019

I personally think it doesn't make sense to maintain our full git tutorial and we should just strip that all out and put some links to generic tutorials (e.g. https://guides.github.com/).

@jklymak
Copy link
Member

jklymak commented Jul 13, 2019

@anntzer I’d have had trouble getting a work flow together from those tutorials. They are bizarrely devoid of command line examples, perhaps on the assumption a lot of folks will use a GUI?

@anntzer
Copy link
Contributor

anntzer commented Jul 14, 2019

I just picked these links as the first thing that google gave me, but certainly there can be better choices?
Or at least we should try to revive the upstream gitwash project and just link to it. Certainly we can share the same tutorial with numpy/scipy/whatnot? Hopefully if you can contribute to any of these projects, you're able to replace github.com/<repoowner>/<reponame> by github.com/matplotlib/matplotlib or whatnot.

@jklymak
Copy link
Member

jklymak commented Jul 15, 2019

I thought that's what gitwash was supposed to be?

@jklymak
Copy link
Member

jklymak commented Jul 15, 2019

After a quick look, and I'd be fine just linking w/ numpy's tutorial. It seems comprehensive and their workflow is close enough to ours.

@jklymak
Copy link
Member

jklymak commented Jul 17, 2019

I'm closing this because these changes won't take effect. If anyone feels strongly about not using gitwash, we can open a new issue... Thanks @RebeccaWPerry !

@jklymak jklymak closed this Jul 17, 2019
@timhoffm
Copy link
Member

timhoffm commented Jul 17, 2019 •
edited
Loading

As far as I can see, these changes would take effect - unless we sync with the gitwash repo, which I don't think we do (otherwise why would the doc be here).

Edit: In the CircleCI build at least this has an effect: https://22918-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/devel/gitwash/configure_git.html?highlight=what%20your%20config%20file

So until someone comes up with a replacement for gitwash, this would at least be an improvement.

@timhoffm timhoffm reopened this Jul 17, 2019
@jklymak
Copy link
Member

jklymak commented Jul 17, 2019 

All documentation in the gitwash directory are automatically generated by running the gitwash_dumper.py
script in the project's root directory using the following parameters:

python gitwash_dumper.py doc/devel Matplotlib --repo-name=matplotlib --github-user=matplotlib \
   --project-url=http://matplotlib.org \
   --project-ml-url=https://mail.python.org/mailman/listinfo/matplotlib-devel

The script is hosted at https://raw.githubusercontent.com/matthew-brett/gitwash/master/gitwash_dumper.py.
For more information please visit https://github.com/matthew-brett/gitwash

timhoffm
timhoffm reviewed Jul 17, 2019
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Probably, this won't stay forever, but until we have something else, this is an improvement.

@timhoffm
Copy link
Member

@jklymak the last run seems to have been Feb 2017. Since then we've had some local changes. So we're down that road already. Since the gitwash project seems dead anyway, that's not too much of an issue.

@jklymak
Copy link
Member

jklymak commented Jul 18, 2019

Sounds good. I think we should discuss a way forward but it’s not urgent.

@jklymak jklymak merged commit 7a57959 into matplotlib:master Jul 18, 2019
@timhoffm
Copy link
Member

@RebeccaWPerry thanks, and congratulations on your first contribution to Matplotlib! Hope to see you back some time.

@QuLogic QuLogic added this to the v3.2.0 milestone Jul 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.
6 participants
@RebeccaWPerry @jklymak @dstansby @anntzer @timhoffm @QuLogic
Morty Proxy This is a proxified and sanitized view of the page, visit original site.