Hi everyone,
I’m currently contributing to nbformat documentation and had a question regarding the
changelog entry for version 5.5.0.
Specifically, the explanation around the normalize behavior is not fully clear to me —
in particular whether normalize() is expected to automatically fix missing cell IDs,
or whether it is intended as an explicit, manual helper.
I’ve gone through the existing docs and related issues, but I’m still unsure about the
intended behavior and whether additional clarification would be welcome.
I’m considering improving the documentation around this and wanted to ask:
- Is there a preferred or canonical explanation of
normalize()for this version? - Is
normalize()meant to be an explicit helper rather than an automatic fix? - Would a small clarification or example be better placed in the changelog or in the docs?
Any guidance from maintainers or contributors would be really appreciated.
Thank you for your time!