nteract/testbook

Document how the executing kernel is chosen

Open

#99 opened on Apr 15, 2021

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)Python (38 forks)auto 404
documentationgood first issuesprint-friendly

Repository metrics

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

Description

Hi there,

I recently reinstalled my kernels and suddenly, my tests were no longer passing due to the wrong kernel being used...

I managed to fix the problem but I think it would be nice in the docs to:

  • Tell that by default, the executing kernel is the one named python3
  • Show that this can be changed by setting kernel_name in the decorator
  • And perhaps that the kernel can be set from the metadata of the notebook by setting kernel_name to '' ?

Contributor guide

Research direction
Explain how the executing kernel is chosen by default and how to change it using kernel name in the decorator or metadata.
Tech stack
python
Domain
documentationtesting
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85