Re: [spyder] Enhancement: Rich text docstring moved to thread

82 views
Skip to first unread message

Jed Ludlow

unread,
Dec 17, 2012, 10:37:50 AM12/17/12
to spyderlib
On Sat, Dec 15, 2012 at 10:28 PM, Steven Silvester <steven.s...@gmail.com> wrote:
Hey all, I hacked at spyderlib/plugins/inspector.py to create the rich text doc strings in a QThread, to avoid the annoying lockup while editing.  I tested it and it works great.  Let me know if there is a better way to submit these changes.

I know you all talked about switching to GitHub earlier, and I would like to echo that sentiment.  I have contributed to scikit-image and enaml, and it has been as simple as sending them a pull request, having inline discussions on the site, and them absorbing the changes directly.  The folks at scikit-image have posted an excellent workflow description, modeled after the one used by the IPython developers:  http://scikit-image.org/docs/dev/gitwash/index.html.   I was using mercurial prior to working with them, but GitHub has completely sold me, and the minor differences have not been troubling.

Regards,
Steve Silvester

Hi, Steve.

As an aside, the github workflow you are looking for is possible with Google Code. It's just not as well known.

The notion of "fork" is replaced with personal server-side "clones" of the project:


You can push changes to these clones to share them. Once you have created a clone, you can enable code review in the clone under the "Administer...Source..." tab of the clone settings. Make sure both "Enable code reviews" and "Allow non-members to review code" are checked if you want to let others make comments on your proposed changes.

The basic idea behind a git "feature branch" can be replicated in Hg by using Hg bookmarks. Hg named branches carry a bit more weight than bookmarking since they can't really be deleted. Hg bookmarks are a better analog to git branches.

There is no specific "pull request" mechanism on Google Code, but just create a new case in the issue tracker (or edit the existing case if you're working on an already reported issue) and make reference to the fact that you are looking for a code review and a pull from your clone. Make sure you include a link to your clone and the name of the bookmark in your clone somewhere in the case text so it's easier to find the changes.

Carlos Córdoba

unread,
Dec 17, 2012, 12:42:31 PM12/17/12
to spyd...@googlegroups.com
Hi Steve,

Thanks for the enhancement, it's really appreciated! Rich text docs are
one of our selling points and I have a lot of cool plans for them in the
future. It was quite annoying to see them blocking the entire app
though, so that's why your contribution is so important!

About Github: Given that all our devs are more fond of mercurial than of
git (especially because of Tortoisehg), I've been considering to just
open a github mirror (instead of doing a full migration, which was my
initial proposal). So all our issues and development workflow will stay
in google-code, but we could still get contributions of people who
prefer Github. This is very important, because several people (like you)
have manifested their interest in contributing but have been
disappointed by our lack of a Github repo.

Now that you raise the issue again, I'll do a couple of experiments to
see how easy is to integrate back changes in Github to our mercurial
repo, and I'll probably open the mirror next week.

Cheers,
Carlos

El 16/12/12 00:28, Steven Silvester escribió:
> Hey all, I hacked at spyderlib/plugins/inspector.py to create the rich
> text doc strings in a QThread, to avoid the annoying lockup while
> editing. I tested it and it works great. Let me know if there is a
> better way to submit these changes.
>
> I know you all talked about switching to GitHub earlier, and I would
> like to echo that sentiment. I have contributed to scikit-image and
> enaml, and it has been as simple as sending them a pull request,
> having inline discussions on the site, and them absorbing the changes
> directly. The folks at scikit-image have posted an excellent workflow
> description, modeled after the one used by the IPython developers:
> http://scikit-image.org/docs/dev/gitwash/index.html. I was using
> mercurial prior to working with them, but GitHub has completely sold
> me, and the minor differences have not been troubling.
>
> Regards,
> Steve Silvester
> --
> You received this message because you are subscribed to the Google
> Groups "spyder" group.
> To view this discussion on the web visit
> https://groups.google.com/d/msg/spyderlib/-/gnh5e8azgLwJ.
> To post to this group, send email to spyd...@googlegroups.com.
> To unsubscribe from this group, send email to
> spyderlib+...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/spyderlib?hl=en.

Jed Ludlow

unread,
Dec 17, 2012, 4:44:11 PM12/17/12
to spyderlib
On Mon, Dec 17, 2012 at 10:42 AM, Carlos Córdoba <ccord...@gmail.com> wrote:

About Github: Given that all our devs are more fond of mercurial than of git (especially because of Tortoisehg), I've been considering to just open a github mirror (instead of doing a full migration, which was my initial proposal). So all our issues and development workflow will stay in google-code, but we could still get contributions of people who prefer Github. This is very important, because several people (like you) have manifested their interest in contributing but have been disappointed by our lack of a Github repo. 
 
The previous discussions about Github are almost a year old now. At the time, it looked like Google Code was actively moving toward something that felt like Github, but that certainly hasn't happened. Perhaps enough has changed in the world that a full move to Github is now more logical than before.

Carlos Córdoba

unread,
Dec 17, 2012, 10:10:48 PM12/17/12
to spyd...@googlegroups.com
Last time Pierre said (and I still agree) that there are not good multiplatform gui clients for git. Tortoisehg is very good and I think Pierre is also distributing it with WinPython because he is using it for his projects.

I'd say we should leave our issues in google-code and I'd be in favor of moving our repos only if we could attract more contributors. But we could just open a mirror to see if that's the case or not.

What do you think now Pierre?

El 17/12/12 16:44, Jed Ludlow escribió:
On Mon, Dec 17, 2012 at 10:42 AM, Carlos Córdoba <ccord...@gmail.com> wrote:

About Github: Given that all our devs are more fond of mercurial than of git (especially because of Tortoisehg), I've been considering to just open a github mirror (instead of doing a full migration, which was my initial proposal). So all our issues and development workflow will stay in google-code, but we could still get contributions of people who prefer Github. This is very important, because several people (like you) have manifested their interest in contributing but have been disappointed by our lack of a Github repo. 
 
The previous discussions about Github are almost a year old now. At the time, it looked like Google Code was actively moving toward something that felt like Github, but that certainly hasn't happened. Perhaps enough has changed in the world that a full move to Github is now more logical than before.
--
You received this message because you are subscribed to the Google Groups "spyder" group.

Steven Silvester

unread,
Dec 18, 2012, 12:00:13 AM12/18/12
to spyd...@googlegroups.com
I actually saw the Github mirror. I was reluctant to fork and submit a pull request because it might not be the latest version and/or was not an encouraged method. Maybe put a note to developers about your mirror update rate/method and an encouragement to submit PRs through GitHub if that is their preferred method. Otherwise, a desciption of how to accomplish the similiar Google code method.

Steven Silvester

unread,
Dec 18, 2012, 12:01:18 AM12/18/12
to spyd...@googlegroups.com
And there's this: "This is the official mirror for Spyder on GitHub and it's meant to be read-only."

Steven Silvester

unread,
Dec 18, 2012, 12:11:19 AM12/18/12
to spyd...@googlegroups.com
Sorry, one more point. If the gui tool is the only factor, you can use hg-git and seamlessly use mercurial locally but link to GitHub.

Jonatan Hjul

unread,
Dec 18, 2012, 3:30:13 AM12/18/12
to spyd...@googlegroups.com
What about tortoisegit?

Carlos Córdoba

unread,
Dec 18, 2012, 11:26:05 AM12/18/12
to spyd...@googlegroups.com
@Steven:
1. The mirror you found is read only because we are using it to create Ubuntu packages for our beta version. It's there so that Launchpad can automatically sync it and package a deb for us, that's why we are not receiving PR's for it. When I was talking about a mirror, I was thinking about opening a different one to this, also under our Github organization.

2. I used hg-git in the past and it didn't work well for me (it corrupted my repo). It was probably my fault because I mixed in my head mercurial and git concepts (like pull and checkout). It has probably improved now, I don't know, I haven't checked it in a long time. All in all I think it's better to use native tools (that's what I've been using for the very few repos I have on GH).

@Jonatan:
tortoisegit is only for windows and I work on Linux.

But don't worry guys, I'm decided to open a proper Github mirror this time. Hey, it'll be more work for me because I'll have to merge changes back and forth between google-code and GH, but if we could attract more contributors I'll be happy to do it.

If there is enough people interested in contributing then we could seriously think about switching, but for now I think a mirror is the easiest and less painful thing to do.

Cheers,
Carlos

El 18/12/12 03:30, Jonatan Hjul escribió:
What about tortoisegit?



Den tirsdag den 18. december 2012 06.11.19 UTC+1 skrev Steven Silvester:
Sorry, one more point.  If the gui tool is the only factor, you can use hg-git and seamlessly use mercurial locally but link to GitHub.
--
You received this message because you are subscribed to the Google Groups "spyder" group.
To view this discussion on the web visit https://groups.google.com/d/msg/spyderlib/-/daK5HQZZn14J.

Steven Silvester

unread,
Dec 18, 2012, 11:34:19 PM12/18/12
to spyd...@googlegroups.com
Okay, I completed the clone workflow on Google code. Thanks for the walkthrough Jed.

Also, I tried out QGit on Ubuntu and it is pretty well featured. Fernando Pérez speaks well of it here: http://www.fperez.org/py4science/git.html

sudo apt-get install qgit

Jonatan Hjul

unread,
Dec 19, 2012, 2:42:24 AM12/19/12
to spyd...@googlegroups.com
There seems to be support on the KDE/Qt side as well: http://sebastian-doerner.de/2011/09/a-git-plugin-for-dolphin/

And RabbitVCS is that not written for Gnome?

It is not that have much personal preference on github over google code, but it seems like github is where the rest of the scientific community is...

Steve

unread,
Dec 19, 2012, 12:11:10 PM12/19/12
to spyd...@googlegroups.com
Where is the github mirror?

Steven Silvester

unread,
Dec 19, 2012, 6:37:19 PM12/19/12
to spyd...@googlegroups.com
The one I came across is at: https://github.com/spyder-ide

Pierre Raybaut

unread,
Jan 2, 2013, 10:48:20 AM1/2/13
to spyd...@googlegroups.com
2012/12/18 Carlos Córdoba <ccord...@gmail.com>:
> Last time Pierre said (and I still agree) that there are not good
> multiplatform gui clients for git. Tortoisehg is very good and I think
> Pierre is also distributing it with WinPython because he is using it for his
> projects.

I prefer to stay with GoogleCode indeed but for bad reasons: all my
projects are source-controlled using Mercurial (open-source *and*
internal projects) and it would cost me time (that I don't have
anymore) to move them to git. A single tool for managing all my
projects is important (and there is the fact that WinPython could not
include TortoiseHg and TortoiseGit). For a year now, I also have so
limited time to spend on FOSS that I'm afraid I can't afford to spend
time on learning a new VCS.

So, if there was a way to keep a GitHub repo synchronized with the
GoogleCode Hg repo, it would be really nice.
Reply all
Reply to author
Forward
0 new messages