Issue #32 resolved

Fix Doc/library/Stackless .rst documentation for new features

Kristján Valur Jónsson
created an issue

A bunch of new features has been added. tasklet.throw tasklet.bind_thread() tasklet.switch() stackless.atomic() stackless.switch_block channel.throw()

All of these methods really need entries in the .rst files, sadly this has been left undone for a long, long, time.

Comments (6)

  1. rmtew

    The only realistic way to have these be done in a timely fashion, is to have whomever makes a change, update the documentation as part of the checkin. Failing that, before it is considered finalised and merged to other branches, might be another key point to ensure documentation is done.

  2. Anonymous

    Ok, then what if, like Kristjan just did, there is a change to a bunch of files, but he just says that docu updates will come, soon?

    I propose to go this way when the check-in is not one but a series:

    Start a feature branch. I think the support is not in BB, but in Sourcetree. Start a feature branch, do the series of check-ins, also for documentation, then finish the branch and do the missing merges.

  3. Kristján Valur Jónsson reporter

    Of course I should have updated these as we went a long. I must confess that I was unaware of a stackless.rst documentation.

    Christian, the simplest way to do these things you suggest is via pull requests, this is how people generally work these days (I'm told). So, we'd "fork" the stackless depot, work in the fork, and then do a pull request.

    Fork,. however, is not available for a "private" repo, which stackless currently is, so I have not been able to test it in this scenario.

  4. Anonymous

    Kristján Valur Jónsson ah, I see, no forking.

    I think it is a bit different. Forking is one thing, pull request another. The usual way for people without write access is to fork, in order to create a pull requests. But you can also create a pull request between branches, and this should work with a private repos, also.

    If you look at how the PyPy people work, you see checkins in branches, which finally get merged, or are even kept open for some reason. Pull requests are used from others, they get sometimes discussion, and they are then merged. They admittedly over-use the branching feature a bit. You can look at where they work on many branches, and sometimes merge pull requests. But the structuring element at PyPy is branches, with or without pull-request.

  5. Log in to comment