Fix various typos and formatting

sanity-io / GROQ

Specification for GROQ - The Query Language for JSON

https://groq.dev

MIT License

398 stars 15 forks source link

Fix various typos and formatting #90

Closed judofyr closed 2 years ago

judofyr commented 2 years ago

Fix various typos.
Use example code blocks.
spec-md doesn't support "::" in the middle of an identity which means that these sections weren't handled as "algorithms". This changes it to use _ as delimiter instead which means that they get properly linked, referenced and appears in the index.

atombender commented 2 years ago

I noticed a "prettier-ignore" in the middle of the spec, maybe we can fix that:

Screen Shot 2022-08-11 at 17 14 29

judofyr commented 2 years ago

Could we fix spec-md to support ::? It looks pretty ugly (and technically incorrect) to have to use underscores. Maybe we could use a special character (triple underscores?) and then sed during build?

I already requested it https://github.com/leebyron/spec-md/issues/83, but it hasn't got any traction. I'd rather not fork spec-md. It's not too bad IMO, these identifiers are only for referring to the implementation internally in the spec.

judofyr commented 2 years ago

I've fixed the prettier-ignore (in not a very clean way) and fixed the validate functions.