quarto-dev / quarto-dev/quarto-cli

[docs] Format in _metadata.yml are merged with in-document and used in priority over project config

Open
#8,968 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation metadata
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

From discussion at https://github.com/quarto-dev/quarto-cli/discussions/8872

Docs at https://quarto.org/docs/projects/quarto-projects.html#metadata-merging says

The one exception to metadata merging is format. If the document-level YAML defines a format, it must define the complete list of formats to be rendered.

But currently, directory metadata is merged with in-document to be used over project's format
https://github.com/quarto-dev/quarto-cli/blob/248a3a4b1cd8985eb062cd53e53b23326c13eb2d/src/command/render/render-contexts.ts#L391-L437

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the metadata-merging documentation at quarto.org/docs/projects/quarto-projects.html#metadata-merging, then inspect the linked section of src/command/render/render-contexts.ts (lines 391-437). Reproduce the interaction between project, directory, and in-document format settings and confirm that the resulting behavior matches the documented format exception.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.