Ping tutorial updates #476
Conversation
Thanks to Annabel for creating a much cleaner version!
Missing docstrings for API creation and Scott's right we should have that for tutorials
Still missing API links though - will discuss further before merging.
|
@harisorgn I think this is ready for review. I've taken a stab at all the edits Scott suggested. The biggest outstanding thing that I see is there are no direct links to the API or other documentation, but I've added docstrings and included instructions on querying them from the REPL to fill that gap for now. |
|
Also unsure why the documentation fails to build, but all the other tests pass 🙃 |
I'll fix the API page and ping people to add docstrings where missing. Thanks for adding yours.
I think you forgot to comment out the inner |
|
Hmm maybe it can't handle a block that's all commented? Because the inner |
|
Sorry, errors during docs build point to the relevant block in the md file ofc, not the jl, so I thought you missed one |
|
No worries I thought I did too for a minute haha. It looks like including a block with just commented code is the issue, so I'll just remove the optional code for now and we can cover adjacency matrices in another tutorial. |
|
Let me try one thing |
|
Oh nice that looks like it worked! |
* Add citation links * Add alternative method for creating edges from adjacency matrix * New PING network illustration Thanks to Annabel for creating a much cleaner version! * Final tweaks to address direct comments * Updating documentation for PING blocks Missing docstrings for API creation and Scott's right we should have that for tutorials * Adding bullet points to the intro * Suggestions are pretty much covered now Still missing API links though - will discuss further before merging. * Just seeing if this compiles the docs * and does this compile * try adding a note * add offset to last line --------- Co-authored-by: haris organtzidis <[email protected]>
General PR to address the comments from 29 and 26 over in the docs.
Also once we're happy with this we should close 16. Forgot to ping about that (pun intended) during the last pass.
Annabel is working on the updated graphic and should be done this week, so I'm going to try and wrap up all the other edits by then too.