Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
rohitsanj opened this issue May 22, 2021 · 2 comments
Open

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

rohitsanj opened this issue May 22, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers sprint-friendly A good issue for sprint events

Comments

@rohitsanj
Copy link
Member

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.

@rohitsanj rohitsanj added documentation Improvements or additions to documentation good first issue Good for newcomers sprint-friendly A good issue for sprint events labels May 22, 2021
@Boluwatifeh
Copy link
Contributor

hi there @rohitsanj i would love to pick up this issue

@Boluwatifeh
Copy link
Contributor

and just to be clear, tb.get doesnt really return the reference to the objects but the objects itself. What i would be working on is to replace all reference of tb.ref with tb.get since the implementation has changed in the source code according to issue #92

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers sprint-friendly A good issue for sprint events
Projects
None yet
Development

No branches or pull requests

2 participants