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

Clarify documentation of markdown parsing in metadata files #8459

Closed
calliecameron opened this issue Nov 28, 2022 · 3 comments
Closed

Clarify documentation of markdown parsing in metadata files #8459

calliecameron opened this issue Nov 28, 2022 · 3 comments

Comments

@calliecameron
Copy link

The documentation for --metadata-file in the manual says: 'Read metadata from the supplied YAML (or JSON) file. This option can be used with every input format, but string scalars in the YAML file will always be parsed as Markdown'.

I read this as 'the file can be YAML or JSON, but string scalars will only be parsed as markdown in YAML files, not in JSON files'. In fact they're parsed as markdown in both types of files. The documtation should make this clear.

@tarleb
Copy link
Collaborator

tarleb commented Nov 28, 2022

Thank you for raising the issue. If you already have something in mind, please let us know. Suggestion for alternative phrasing are always welcome.

@calliecameron
Copy link
Author

How about: 'Read metadata from the supplied YAML or JSON file. This option can be used with every input format, but string scalars in the metadata file will always be parsed as Markdown.'

@jgm jgm closed this as completed in a4bd4d6 Nov 28, 2022
@jgm
Copy link
Owner

jgm commented Nov 28, 2022

Thanks! I made the change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants