jupyter / jupyter/nbformat

Clarify the the role of utf-8

Open
#181 8 comments 0 reactions 0 assignees View on GitHub
enhancement sprint-friendly
Dominant language
Python
Stars
313
Forks
176
PR merge metrics
No merged PRs in 30d

Description

In several places nbformat seems to choose utf-8 as the default encoding (in particular when `read` or `write` get filenames as input).

Does that mean that notebook files must be utf-8 encoded? If yes, perhaps it would be worth to state it explicitly.

See https://github.com/jupyter/jupyter-sphinx/pull/125 for an example context where this matters.

Contributor guide

Open the contributing guide

Research direction

The issue names no files or tests; start by tracing the filename-based `read` and `write` entry points and reviewing their documentation. Confirm the documented UTF-8 behavior for notebook files, then update the relevant documentation so the encoding requirement or default is explicit.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.