Skip to content
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

Tree-seq docs in the SLiM manual need a review #351

Open
bhaller opened this issue Sep 9, 2022 · 4 comments
Open

Tree-seq docs in the SLiM manual need a review #351

bhaller opened this issue Sep 9, 2022 · 4 comments
Labels
bug long-term trees related to tree-seq, tskit, etc.

Comments

@bhaller
Copy link
Contributor

bhaller commented Sep 9, 2022

On another issue, now closed, I wrote:

I also think that a pass over the SLiM manual's chapter 17, with an eye towards adding mention of this and other real-world issues, and adding cross-links into the pyslim documentation, would be a Very Good Idea. I would suggest that you and I ought to do this kind of separately-but-together: do it one subsection at a time, reading and thinking separately and then having a shared-screen discussion and revision of the manual for that one subsection, then moving on to the next. If we do one subsection at a time, we can spread this work over a longer period of time and make the project less monolithic. It feels important to do, though; SLiM users need to know about these sorts of issues, and need to go to the pyslim doc to read about them, and the existing general statement to "Go read the pyslim doc, it's important" is presumably ignored/forgotten by most users.

"You" is @petrelharp :->. #244 should be folded into this issue. @petrelharp do you have cycles free to do this? It doesn't necessarily have to happen for 4.0.1, but I don't want it to be on the back burner forever, either; improving this doc is important.

@bhaller bhaller added bug priority trees related to tree-seq, tskit, etc. labels Sep 9, 2022
@petrelharp
Copy link
Collaborator

I would like to do this, but have very few free cycles at the moment, as classes are starting soon.

@bhaller
Copy link
Contributor Author

bhaller commented Sep 9, 2022

Yep. #350 is higher priority for now; let's try to get to this one when you have more time. :->

@bhaller
Copy link
Contributor Author

bhaller commented Jul 24, 2023

Hey @petrelharp, what do you think of this issue now? Doing this for the 4.1 release would be nice. It might not require a whole lot of time, if it turns out that the manual already doesn't suck. :-> Maybe this is another possible to-do item for your visit here, if we find ourselves at a loose end. :->

@bhaller
Copy link
Contributor Author

bhaller commented Sep 14, 2023

@petrelharp and I agree that one big thing to do is to move recapitation to the start of the chapter; it should be the foundational technique, used in the other recipes, to avoid problems with simplify() being used too broadly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug long-term trees related to tree-seq, tskit, etc.
Projects
None yet
Development

No branches or pull requests

2 participants