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

Tags in md files require square brackets for jupytext #1776

Open
tobydriscoll opened this issue Jan 13, 2025 · 1 comment · May be fixed by #1780
Open

Tags in md files require square brackets for jupytext #1776

tobydriscoll opened this issue Jan 13, 2025 · 1 comment · May be fixed by #1780
Labels
documentation Improvements or additions to documentation

Comments

@tobydriscoll
Copy link

When I use tags as shown in the docs, jupytext gives an error:

nbformat.validator.NotebookValidationError: 'remove-input' is not of type 'array'

Failed validating 'type' in notebook['properties']['metadata']['properties']['tags']:

On instance['metadata']['tags']:
'remove-input'

When the tag is put inside array brackets, the conversion is successful.

(jupytext v1.16.4)

@rowanc1
Copy link
Member

rowanc1 commented Jan 13, 2025

Do you agree that this is a documentation improvement in mystmd? That is, we default to documenting only the array, and/or is this a validation issue that we can request from jupytext to allow that tool to be more permissive with their coercion and validation around tags.

Happy to take a PR with improving the mystmd docs and moving the examples towards recommending arrays.

@rowanc1 rowanc1 added the documentation Improvements or additions to documentation label Jan 13, 2025
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants