Should `trusted` metadata be documented in notebook file format?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 313
- Forks
- 177
- PR merge metrics
- No merged PRs in 30d
Description
nbformat (Python package) handles trusted as described in https://nbformat.readthedocs.io/en/latest/api.html#module-nbformat.sign. The Cell metadata chapter of the Notebook file format does not describe trusted. Should trusted be added to specification, or is this an implementation detail which was intentionally omitted? If it is omitted by choice, what is the right place to document/discuss quirks around it?
Cross-referencing related discussions:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the nbformat.sign API documentation and the Cell metadata section of the Notebook file format specification. Review the two linked JupyterLab discussions for context on trusted metadata. Done means resolving whether trusted belongs in the specification and documenting it there or identifying the appropriate place for the implementation detail.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100