Including a code-chunk title when code-summary is defined.

[JoFrhwld]

Description

I've started using filename to add brief descriptive titles to my code chunks, which I think is helpful for code legibility. However, it seems like a misuse given the name of the option.

It would be nice if, instead, when the code chunk options are

#| code-fold: false
#| code-summary: "description"

The value given to code-summary was styled like the current filename option in the output. At the moment, the value passed to code-summary only appears in the output when code-fold is true.

[JoFrhwld]

This would also clean up how code chunk titles and code folding interact:

Currently:

#| filename: "description"
#| code-fold: true

• Code folding is ignored
• Code chunk appears with a title

#| filename: "description"
#| code-fold: false

• Code chunk appears with a title

With proposed feature

#| code-summary: "description"
#| code-fold: true

• Code-folding and summary are style as they are currently.

#| code-summary: "description"
#| code-fold: false

• Code chunk appears with a title

[mcanouil]

Filename is not the same thing as code-summary and I don't think they should.

If your concerns are about the style used for the details HTML tag around code blocks, you can customise that yourself.

See for example: https://github.com/EmilHvitfeldt/quarto-revealjs-codewindow

[JoFrhwld]

Agreed that filename shouldn't be the same thing as code-summary. At the moment I'm misusing filename to give descriptive titles to code chunks, as in this screenshot:

I actually got the idea from the quarto docs (source). I would, ideally, put descriptive titles on code chunks using code-summary instead.

[mcanouil]

code-summary refers to the summary HTML tag of a details tag which is what allows code folding.

Note that there is the code listing feature: https://quarto.org/docs/authoring/cross-references.html#code-listings

And extension is also a good way to get whatever you want in whatever shape you want as the example I already shared which could be mixed with code folding.

[JoFrhwld]

It doesn't seem like code listing & list captions can be set within an executed code-chunk.

Realistically, what I'll do is just keep adding descriptive titles to code chunks using filename. I actually think it looks fine, so I don't need to dig into the styling. I just thought the semantics weren't quite right for how I was using it.