tskit icon indicating copy to clipboard operation
tskit copied to clipboard

Should we use >>> in doc examples

Open hyanwong opened this issue 3 years ago • 2 comments

Some docstrings preface example code with >>>, e.g.

https://tskit.dev/tskit/docs/stable/python-api.html#tskit.Tree.count_topologies

and some don't, e.g.

https://tskit.dev/tskit/docs/stable/python-api.html#tskit.Tree.prev

I guess we should pick some convention (I think we could probably remove the >>>, so that copy-paste works more smoothly)

hyanwong avatar Sep 28 '22 09:09 hyanwong

I'm guessing the repl form is quite old, predating the systematic use of sphinx. Happy to remove

jeromekelleher avatar Sep 28 '22 11:09 jeromekelleher

I'm guessing the repl form is quite old, predating the systematic use of sphinx. Happy to remove

Agreed!

benjeffery avatar Sep 28 '22 11:09 benjeffery