typst-community / typst-community/prequery

single or double square brackets in typst.toml?

Open
#9 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Typst
Stars
16
Forks
1
PR merge metrics
No merged PRs in 30d

Description

the typst.toml manifest found here: https://github.com/typst/packages/blob/main/docs/manifest.md
says that tools should use the format

[package]
# ...

[tool.mytool]
foo = "bar"

but in the perjury documentation found here: https://typst-community.github.io/prequery/quickstart/preprocessor.html
it says to use double square brackets.

[package]
#...

[[tool.prequery.jobs]]
name = "download"
kind = "web-resource"

what should be used?

Contributor guide

No contributing guide indexed for this repository

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

Compare the manifest documentation at docs/manifest.md with the prequery quickstart at quickstart/preprocessor.html, focusing on the differing [tool.mytool] and [[tool.prequery.jobs]] examples. Confirm which TOML structure prequery expects, then update the conflicting documentation so the syntax and intended job configuration are unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.