nteract/testbook

Replace all tb.ref examples in docs with tb.get

Offen

#117 geöffnet am 22.05.2021

 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (38 Forks)auto 404
documentationgood first issuesprint-friendly

Repository-Metriken

Stars
 (435 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

With #92, a new way of creating reference objects was introduced.

  • We will need to replace all instances of tb.ref with tb.get and also mention that one can use the indexing pattern to create the objects.
  • Also mention that when the object is JSON serializable, when tb.get is called on that variable, the actual value will be fetched, and not the reference object, which was the case before. (This is the actual reason why we need to move away from tb.ref examples because they no longer return "references" always.)
  • Provide a few code examples to demonstrate the new pattern.

This piece of code outlines the different ways we can create testbook reference objects as of now.

Contributor Guide