Matplotlib plotting backend is not documented

[szhorvat]

Describe the bug

Matplotlib plotting backend is not documented.

See https://igraph.org/python/doc/api/igraph.drawing.html#plot

Version information 0.9.1

[iosonofabio]

Hmm, I've documented it somewhere, but perhaps not everywhere. I'll take a look

[szhorvat]

It would be great to have some documentation on this before the next python-igraph release.

We might also want to mark it as "experimental". This will communicate that it's not finished functionality and it may change. The idea is to have things documented, so people can use them and give feedback, but not yet commit to the API or behaviour.

[iosonofabio]

Alright, I had already documented it in the online manual here:

https://igraph.org/python/doc/tutorial/visualisation.html#plotting-graphs-within-matplotlib-figures

but the docstring of the function wasn't changed. My bad, let me add the info there too.

When explaining this kind of stuff, tutorials are most useful. The current tutorial:

https://igraph.org/python/doc/tutorial/tutorial.html#drawing-a-graph-using-a-layout

uses Cairo only, would you like me to add a matplotlib part to it? also the Python syntax in that tutorial is very 90s, pre PEP8 ;-)

[szhorvat]

Re tutorial: I went through the plotting parts of the tutorial the other day (since I have a lot to learn in this area!) and noticed that the plots included in the tutorial are not quite the same as the what the preceding code produces. It would be nice to fix this. I'll let you know a bit later what the mismatch was (I need to look again).

[iosonofabio]

I've now opened a PR on this, as you can see, happy to fix the tutorial based on what you find out!

Thank you!

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.