Major docs upgrade PRs ready for review

3 views

Skip to first unread message

Russell Jurney

unread,

Feb 17, 2025, 5:19:28 PMFeb 17

to GraphFrames

So I want to thank everyone that reviewed my original messy PR. I took a hint from Bjorn and redid them all to be absolutely minimal and just what they involve. I hope you now approve of these.

They're dependent. 3--bases-on-->2--bases-on-->1, need to be merged in that order. There was no other way to do it, I only did #1 and #2 because I couldn't do #3 without them. So much stuff was old and broken it snowballed. I did not put the PyTest conversion in these PRs - I will have to do that at the Hackathon maybe.

So if you get a chance, I would really appreciate it if we could try to get these in by Thursday - a big ask I know - for the Hackathon. If we could do a v0.8.5 release Thursday that would be optimal. The new README, updated docs and motif finding tutorial will help people get onboarded much faster. If not, that's okay, I can just point them to my docs branch but it won't be serving the formatted docs... so yeah.

1. A minimal poetrization to build a Python package

2. Code for docs update including motif finding tutorial

3. Docs updates including motif finding tutorial

Thanks,

Russell Jurney

unread,

Feb 20, 2025, 2:29:31 AMFeb 20

to GraphFrames

If any of you have time to look this over today I would really appreciate it. I'd like to merge today so we can have good documentation in place for the hackathon tomorrow.