nteract/testbook

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

Open

#117 opened on May 22, 2021

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (38 forks)auto 404
documentationgood first issuesprint-friendly

Repository metrics

Stars
 (435 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Research direction
Look at the linked PR #92 and the code in testbook/client.py to understand the new pattern for reference objects (tb.get), then update all instances of tb.ref in documentation and add code examples demonstrating tb.get and the indexing pattern.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85