Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

_repr_svg_ needs better documentation

See original GitHub issue

_repr_svg_ has additional return options as mentioned by @takluyver here: https://github.com/igraph/python-igraph/issues/145#issuecomment-344283193

I couldn’t find the fact that _repr_svg_ could return a tuple mentioned anywhere. Specifically, this could be mentioned here:

Perhaps there are other _repr_ functions that are also under-documented.

Issue Analytics

State:
Created 6 years ago
Comments:8 (6 by maintainers)

Top GitHub Comments

2reactions

GabrielSimonettocommented, Sep 7, 2020

Hi, it seems to me this issue can be closed since it was resolved on PR #11352, @takluyver, @dsblank

2reactions

takluyvercommented, Jan 9, 2018

I think all the _repr_*_ functions can now return a data, metadata tuple. I only became aware of it recently, but I’m not sure when it started.

Here’s another place this could be documented - I think narrative docs may be better for this than API docs. http://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display

Top Results From Across the Web

5 Tips for Improving Documentation | CloudApp Blog

But improving documentation is essential for any business looking to grow and achieve a high level of success. In this article, we'll cover...

Need for better documentation - Medium

Their managers and leaders don't think of documentation as a necessity, even though oftentimes they base their own decisions regarding what software to...

A PyMC3 Analysis of Tyrannosaurid Growth Curves · GitHub

A hierarchical model will allow us to share information from taxa with more observations when inferring the posterior distributions of ...

pyuvis - PyPI

This package provides tools to work with Cassini UVIS data. How to install. It is recommended to manage your Python environments with conda...

Building Better Documentation Practices for Developers, Part 1

Developers care about docs and will pass up working on an open source project because it lacks good documentation. Learn more.